Projects | API Reference | Turing-APAC Docs

List Projects

get

List all projects user has access to.

Optionally filter by team_id.

Query parameters

team_idany ofOptional

Filter by team ID

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for project.

project_idstringRequired

project_namestringRequired

team_idstringRequired

org_idstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusstringRequired

user_roleany ofOptional

stringOptional

or

nullOptional

statsany ofOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/projects

GET /v1/admin/projects HTTP/1.1
Accept: */*

[
  {
    "project_id": "text",
    "project_name": "text",
    "team_id": "text",
    "org_id": "text",
    "description": "text",
    "status": "text",
    "user_role": "text",
    "stats": {
      "total_requests": 0,
      "total_api_keys": 0,
      "member_count": 0
    }
  }
]

Create Project

post

Create a new project.

Requires: team_admin role or higher for the parent team

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request model for creating a project.

project_namestring · min: 1 · max: 100Required

team_idstringRequired

Parent team ID

descriptionany ofOptional

string · max: 500Optional

or

nullOptional

allowed_servicesany ofOptional

Services this project can access

string[]Optional

or

nullOptional

rate_limitany ofOptional

integer · min: 1 · max: 10000Optional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/projects

POST /v1/admin/projects HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "project_name": "text",
  "team_id": "text",
  "description": "text",
  "allowed_services": [
    "text"
  ],
  "rate_limit": 1
}

{
  "project_id": "text",
  "project_name": "text",
  "team_id": "text",
  "org_id": "text",
  "description": "text",
  "status": "text",
  "user_role": "text",
  "stats": {
    "total_requests": 0,
    "total_api_keys": 0,
    "member_count": 0
  }
}

Get Project

get

Get project details.

User must have access to the project's team.

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for project.

project_idstringRequired

project_namestringRequired

team_idstringRequired

org_idstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusstringRequired

user_roleany ofOptional

stringOptional

or

nullOptional

statsany ofOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/projects/{project_id}

GET /v1/admin/projects/{project_id} HTTP/1.1
Accept: */*

{
  "project_id": "text",
  "project_name": "text",
  "team_id": "text",
  "org_id": "text",
  "description": "text",
  "status": "text",
  "user_role": "text",
  "stats": {
    "total_requests": 0,
    "total_api_keys": 0,
    "member_count": 0
  }
}

Delete Project

delete

Delete (soft delete) a project.

Requires: team_admin or org_admin role

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/admin/projects/{project_id}

DELETE /v1/admin/projects/{project_id} HTTP/1.1
Accept: */*

No content

Update Project

patch

Update project details.

Requires: project_admin role or higher

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request model for updating a project.

project_nameany ofOptional

string · min: 1 · max: 100Optional

or

nullOptional

descriptionany ofOptional

string · max: 500Optional

or

nullOptional

allowed_servicesany ofOptional

string[]Optional

or

nullOptional

rate_limitany ofOptional

integer · min: 1 · max: 10000Optional

or

nullOptional

enable_audit_logany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for project.

project_idstringRequired

project_namestringRequired

team_idstringRequired

org_idstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusstringRequired

user_roleany ofOptional

stringOptional

or

nullOptional

statsany ofOptional

or

nullOptional

422

Validation Error

application/json

patch

/v1/admin/projects/{project_id}

PATCH /v1/admin/projects/{project_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "project_name": "text",
  "description": "text",
  "allowed_services": [
    "text"
  ],
  "rate_limit": 1,
  "enable_audit_log": true
}

{
  "project_id": "text",
  "project_name": "text",
  "team_id": "text",
  "org_id": "text",
  "description": "text",
  "status": "text",
  "user_role": "text",
  "stats": {
    "total_requests": 0,
    "total_api_keys": 0,
    "member_count": 0
  }
}

Get Project Metadata

get

Get project metadata.

If key is provided, returns only that key's value. Otherwise, returns all metadata.

Path parameters

project_idstringRequired

Query parameters

keyany ofOptional

Specific metadata key to retrieve

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

get

/v1/admin/projects/{project_id}/metadata

GET /v1/admin/projects/{project_id}/metadata HTTP/1.1
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Set Project Metadata

put

Set or update a specific metadata key.

Requires: project_admin role or higher

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request to set metadata key.

keystringRequired

valueanyRequired

Responses

200

Successful Response

application/json

Response model for project.

project_idstringRequired

project_namestringRequired

team_idstringRequired

org_idstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusstringRequired

user_roleany ofOptional

stringOptional

or

nullOptional

statsany ofOptional

or

nullOptional

422

Validation Error

application/json

put

/v1/admin/projects/{project_id}/metadata

PUT /v1/admin/projects/{project_id}/metadata HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "key": "text",
  "value": null
}

{
  "project_id": "text",
  "project_name": "text",
  "team_id": "text",
  "org_id": "text",
  "description": "text",
  "status": "text",
  "user_role": "text",
  "stats": {
    "total_requests": 0,
    "total_api_keys": 0,
    "member_count": 0
  }
}

Merge Project Metadata

patch

Merge multiple metadata keys at once.

Existing keys are updated, new keys are added. Requires: project_admin role or higher

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Other propertiesanyOptional

Responses

200

Successful Response

application/json

Response model for project.

project_idstringRequired

project_namestringRequired

team_idstringRequired

org_idstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusstringRequired

user_roleany ofOptional

stringOptional

or

nullOptional

statsany ofOptional

or

nullOptional

422

Validation Error

application/json

patch

/v1/admin/projects/{project_id}/metadata

PATCH /v1/admin/projects/{project_id}/metadata HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "project_id": "text",
  "project_name": "text",
  "team_id": "text",
  "org_id": "text",
  "description": "text",
  "status": "text",
  "user_role": "text",
  "stats": {
    "total_requests": 0,
    "total_api_keys": 0,
    "member_count": 0
  }
}

Delete Project Metadata

delete

Delete a specific metadata key.

Requires: project_admin role or higher

Path parameters

project_idstringRequired

keystringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for project.

project_idstringRequired

project_namestringRequired

team_idstringRequired

org_idstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusstringRequired

user_roleany ofOptional

stringOptional

or

nullOptional

statsany ofOptional

or

nullOptional

422

Validation Error

application/json

delete

/v1/admin/projects/{project_id}/metadata/{key}

DELETE /v1/admin/projects/{project_id}/metadata/{key} HTTP/1.1
Accept: */*

{
  "project_id": "text",
  "project_name": "text",
  "team_id": "text",
  "org_id": "text",
  "description": "text",
  "status": "text",
  "user_role": "text",
  "stats": {
    "total_requests": 0,
    "total_api_keys": 0,
    "member_count": 0
  }
}

List Project Members

get

List all members of a project.

Requires: read:project permission

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for project member.

user_idstringRequired

user_emailstringRequired

user_namestringRequired

user_pictureany ofOptional

stringOptional

or

nullOptional

rolestringRequired

assigned_atstringRequired

assigned_byany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/projects/{project_id}/members

GET /v1/admin/projects/{project_id}/members HTTP/1.1
Accept: */*

[
  {
    "user_id": "text",
    "user_email": "text",
    "user_name": "text",
    "user_picture": "text",
    "role": "text",
    "assigned_at": "text",
    "assigned_by": "text"
  }
]

Add Project Member

post

Add a member to a project.

Requires: manage:project_users permission

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request to add a member to a project.

user_idany ofOptional

stringOptional

or

nullOptional

user_emailany ofOptional

stringOptional

or

nullOptional

rolestring · enumOptional

Project role (project_admin, editor, viewer)

Default: viewerPossible values:

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/projects/{project_id}/members

POST /v1/admin/projects/{project_id}/members HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "user_id": "text",
  "user_email": "text",
  "role": "viewer"
}

No content

Bulk Add Project Members

post

Bulk add members to a project.

Max 100 users per request
Returns success/failure per user
Requires: manage:project_users permission

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

Request to bulk add members to a project.

user_idsstring[] · min: 1 · max: 100Required

List of user IDs (max 100)

rolestring · enumOptional

Role to assign to all users (project_admin, editor, viewer)

Default: viewerPossible values:

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/projects/{project_id}/members/bulk

POST /v1/admin/projects/{project_id}/members/bulk HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "user_ids": [
    "text"
  ],
  "role": "viewer"
}

No content

Remove Project Member

delete

Remove a member from a project.

Requires: manage:project_users permission

Path parameters

project_idstringRequired

user_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/admin/projects/{project_id}/members/{user_id}

DELETE /v1/admin/projects/{project_id}/members/{user_id} HTTP/1.1
Accept: */*

No content

Good night

hashtagList Projects

hashtagCreate Project

hashtagGet Project

hashtagDelete Project

hashtagUpdate Project

hashtagGet Project Metadata

hashtagSet Project Metadata

hashtagMerge Project Metadata

hashtagDelete Project Metadata

hashtagList Project Members

hashtagAdd Project Member

hashtagBulk Add Project Members

hashtagRemove Project Member

List Projects

Create Project

Get Project

Delete Project

Update Project

Get Project Metadata

Set Project Metadata

Merge Project Metadata

Delete Project Metadata

List Project Members

Add Project Member

Bulk Add Project Members

Remove Project Member