Schemas

Download schema

ErrorResponse

error

string · required

RateLimitedErrorResponse

error

const · required

Const value: rate_limited

retryAfterSec

integer · min: 1 · required

QuotaExceededErrorResponse

error

const · required

Const value: quota_exceeded

surface

enum · required

Enum values:

developer_api

limit

integer · min: 1 · required

used

number · min: 0 · required

resetAt

string · date-time · required

BillingUnavailableErrorResponse

error

const · required

Const value: billing_unavailable

InsufficientScopeErrorResponse

error

const · required

Const value: insufficient_scope

missingScopes

string[] · required

CreateCredentialRequest

workspaceId

string · uuid · required

name

string · minLength: 3 · maxLength: 120 · required

workspaceRole

enum · required

Enum values:

member

admin

DeveloperApiScope[] · minItems: 1 · required

Enum values:

conversations:read

conversations:write

agents:read

models:read

projects:read

documents:read

documents:write

artifacts:read

expiresAt

string | null · date-time

allowNoExpiry

boolean

environment

enum

Enum values:

prod

test

Default: prod

CreateCredentialResponse

ok

const · required

Const value:

secret

string · required

Plaintext secret returned exactly once. Do not log it.

DeveloperApiCredentialSummary · required

DeveloperApiCredentialSummary

id

string · uuid · required

workspaceId

string · uuid · required

name

string · required

kind

const · required

Const value: workspace_api_key

workspaceRole

enum · required

Enum values:

member

admin

DeveloperApiScope[] · required

Enum values:

conversations:read

conversations:write

agents:read

models:read

projects:read

documents:read

documents:write

artifacts:read

fingerprint

string · required

Non-secret credential fingerprint.

status

enum · required

Enum values:

active

revoked

expired

expiresAt

string | null · date-time · required

createdAt

string · date-time · required

createdBy

string | null · uuid · required

revokedAt

string | null · date-time · required

revokedBy

string | null · uuid · required

lastUsedAt

string | null · date-time · required

CapabilitiesResponse

ok

const · required

Const value:

CapabilitiesSnapshot · required

CapabilitiesSnapshot

object · required

object[] · required

object · required

AgentListResponse

ok

const · required

Const value:

AgentSummary[] · required

AgentSummary

id

string · uuid · required

slug

string · required

name

string · required

required

createdAt

string · date-time · required

updatedAt

string · date-time · required

ModelListResponse

ok

const · required

Const value:

object · required

ModelSummary

providerId

string · required

providerModelId

string · required

runtimeModelId

string · required

displayName

string · required

contextWindowTokens

integer | null · min: 1 · required

maxOutputTokens

integer | null · min: 1 · required

platformDefault

boolean · required

workspaceDefault

boolean · required

object · required

ProjectListResponse

ok

const · required

Const value:

ProjectSummary[] · required

ProjectSummary

id

string · uuid · required

name

string · required

description

string | null · required

accessMode

enum · required

Enum values:

private

workspace

restricted

createdAt

string · date-time · required

updatedAt

string · date-time · required

archivedAt

string | null · date-time · required

ConversationListResponse

ok

const · required

Const value:

ConversationSummary[] · required

ConversationResponse

ok

const · required

Const value:

ConversationSummary · required

ConversationSummary

id

string · uuid · required

agentId

string | null · uuid · required

projectId

string | null · uuid · required

title

string | null · required

accessMode

enum · required

Enum values:

private

workspace

restricted

includeTransverseKnowledge

boolean · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

archivedAt

string | null · date-time · required

CreateConversationRequest

conversationId

string · uuid

agentId

string | null · uuid

projectId

string | null · uuid

accessMode

enum

Enum values:

private

workspace

restricted

Default: private

DeveloperApiScope

CreateCredentialRequest

workspaceId

string · uuid · required

name

string · minLength: 3 · maxLength: 120 · required

workspaceRole

enum · required

Enum values:

member

admin

DeveloperApiScope[] · minItems: 1 · required

Enum values:

conversations:read

conversations:write

agents:read

models:read

projects:read

documents:read

documents:write

artifacts:read

expiresAt

string | null · date-time

allowNoExpiry

boolean

environment

enum

Enum values:

prod

test

Default: prod

DeveloperApiCredentialSummary

id

string · uuid · required

workspaceId

string · uuid · required

name

string · required

kind

const · required

Const value: workspace_api_key

workspaceRole

enum · required

Enum values:

member

admin

DeveloperApiScope[] · required

Enum values:

conversations:read

conversations:write

agents:read

models:read

projects:read

documents:read

documents:write

artifacts:read

fingerprint

string · required

Non-secret credential fingerprint.

status

enum · required

Enum values:

active

revoked

expired

expiresAt

string | null · date-time · required

createdAt

string · date-time · required

createdBy

string | null · uuid · required

revokedAt

string | null · date-time · required

revokedBy

string | null · uuid · required

lastUsedAt

string | null · date-time · required

ModelSummary

providerId

string · required

providerModelId

string · required

runtimeModelId

string · required

displayName

string · required

contextWindowTokens

integer | null · min: 1 · required

maxOutputTokens

integer | null · min: 1 · required

platformDefault

boolean · required

workspaceDefault

boolean · required

object · required

ProjectSummary

id

string · uuid · required

name

string · required

description

string | null · required

accessMode

enum · required

Enum values:

private

workspace

restricted

createdAt

string · date-time · required

updatedAt

string · date-time · required

archivedAt

string | null · date-time · required

ConversationSummary

id

string · uuid · required

agentId

string | null · uuid · required

projectId

string | null · uuid · required

title

string | null · required

accessMode

enum · required

Enum values:

private

workspace

restricted

includeTransverseKnowledge

boolean · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

archivedAt

string | null · date-time · required