Workspaces
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
1 <= length <= 128Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/invitations/string"{ "kind": "email", "workspace": { "id": "ws_It13CUaGEhLLAB87simX0", "name": "string", "logoUrl": "http://example.com" }, "inviter": { "name": "string", "image": "http://example.com" }, "role": "workspace.member", "expiresAt": "2019-08-24T14:15:22Z", "state": "active", "emailHint": "string"}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Query Parameters
^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$4 <= length <= 100Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/user/invitations/pending?workspace=string"{ "invitationId": "winv_DsgltMIFV0GmqtxV5NYTtrknrna"}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
1 <= length <= 128Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/user/invitations/string/accept"{ "outcome": "joined", "workspaceId": "ws_It13CUaGEhLLAB87simX0", "workspaceName": "string", "role": "workspace.member"}Retrieve all workspaces.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Search workspaces by name
Maximum number of items to return per page
1 <= value <= 10020Cursor for pagination - omit for first page
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces"{ "items": [ { "id": "ws_It13CUaGEhLLAB87simX0", "name": "my-workspace", "logoUrl": "http://example.com", "createdAt": "2019-08-24T14:15:22Z" } ], "nextCursor": "string"}Retrieve a workspace by ID.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0"{ "id": "ws_It13CUaGEhLLAB87simX0", "name": "my-workspace", "logoUrl": "http://example.com", "createdAt": "2019-08-24T14:15:22Z"}Update a workspace.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "ws_It13CUaGEhLLAB87simX0", "name": "my-workspace", "logoUrl": "http://example.com", "createdAt": "2019-08-24T14:15:22Z"}Delete a workspace. The workspace must have no projects and must not be on pay as you go or a contract.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0"List all members of a workspace.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/members"{ "items": [ { "userId": "string", "email": "string", "name": "string", "image": "string", "role": "workspace.member", "joinedAt": "2019-08-24T14:15:22Z" } ]}Add a member to a workspace by email. The user must already have an account.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/members" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "role": "workspace.member" }'{ "userId": "string", "email": "string", "name": "string", "image": "string", "role": "workspace.member", "joinedAt": "2019-08-24T14:15:22Z"}Update a workspace member's role.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/members/string" \ -H "Content-Type: application/json" \ -d '{ "role": "workspace.member" }'{ "userId": "string", "email": "string", "name": "string", "image": "string", "role": "workspace.member", "joinedAt": "2019-08-24T14:15:22Z"}Remove a member from a workspace.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/members/string"Read the ai-agent settings for a workspace. Returns defaults (enabled: true) when the workspace has never customized them.
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/settings"{ "workspaceId": "ws_It13CUaGEhLLAB87simX0", "enabled": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Update the ai-agent settings for a workspace. Supports enabled (false turns the ai-agent off so incoming triggers are rejected before any session runs).
API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/settings" \ -H "Content-Type: application/json" \ -d '{}'{ "workspaceId": "ws_It13CUaGEhLLAB87simX0", "enabled": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations"{ "items": [ { "id": "winv_DsgltMIFV0GmqtxV5NYTtrknrna", "email": "user@example.com", "role": "workspace.member", "status": "pending", "deliveryStatus": "pending", "expiresAt": "2019-08-24T14:15:22Z", "lastSentAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "inviteUrl": "http://example.com" } ]}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "role": "workspace.member" }'{ "id": "winv_DsgltMIFV0GmqtxV5NYTtrknrna", "email": "user@example.com", "role": "workspace.member", "status": "pending", "deliveryStatus": "pending", "expiresAt": "2019-08-24T14:15:22Z", "lastSentAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "inviteUrl": "http://example.com"}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$1 <= length <= 128Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations/string/resend"{ "id": "winv_DsgltMIFV0GmqtxV5NYTtrknrna", "email": "user@example.com", "role": "workspace.member", "status": "pending", "deliveryStatus": "pending", "expiresAt": "2019-08-24T14:15:22Z", "lastSentAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "inviteUrl": "http://example.com"}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$1 <= length <= 128Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations/string"API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invite-link"{ "id": "wil_RgcthDSZ37rmFLekuItpFS7btjXoYwou1gE4", "role": "workspace.member", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "useCount": 0, "lastUsedAt": "2019-08-24T14:15:22Z", "inviteUrl": "http://example.com"}API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invite-link"API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys
In: header
Path Parameters
Unique identifier for the workspace.
ws_[0-9a-zA-Z]{24}$Query Parameters
Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.
^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$4 <= length <= 100Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invite-link" \ -H "Content-Type: application/json" \ -d '{ "role": "workspace.member" }'{ "id": "wil_RgcthDSZ37rmFLekuItpFS7btjXoYwou1gE4", "role": "workspace.member", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "useCount": 0, "lastUsedAt": "2019-08-24T14:15:22Z", "inviteUrl": "http://example.com"}