Skip to main content
GET
List shared HTTP API configurations

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST endpoints the Workspace write API scope.

Response

Success. Empty result sets are also 200.

id
string
required

The value an agent's httpApis[].configId points at.

name
string
required
description
string
required
customerId
string
required
endpoints
object[]
required
secrets
object[]
required

One entry per kind of authentication the API needs. Redaction covers the whole block, so every string value here reads [redacted] — only the entry count and which keys are present carry information.

addedAt
string
required

ISO 8601 timestamp.

addedBy
string
required
updatedAt
string
required

ISO 8601 timestamp.

updatedBy
string
required
instructions
string

Guidance injected into the prompt of agents that use this API.

allAgents
boolean

True means every agent in the workspace may use it.

agentIds
string[]

Agents granted use, in addition to the teams in groupIds.

adminUserIds
string[]
groupIds
string[]

Teams whose agents are granted use.

availableInPhases
string[]
disabled
boolean
{key}
any