Skip to main content
POST
Create a workspace API key

Path Parameters

workspace_id
string<uuid>
required

Body

application/json
name
string
required
Required string length: 1 - 80
scopes
enum<string>[]
required
Required array length: 1 - 6 elements
Available options:
all:read
profile_ids
string<uuid>[]
required
Required array length: 1 - 50 elements

Response

Agent Response Protocol success envelope.

Agent Response Protocol success envelope.

ok
enum<boolean>
required

Whether the API request completed successfully.

Available options:
true
data
object
required

The endpoint-specific response payload.

agent
object
required

Wircle-generated context for AI agents. This object may be empty.