Skip to content
Workshape Catalyst Operator Docs

Config Assets

Set the workspaces an agent is available in

Section titled “Set the workspaces an agent is available in”

PUT /api/v1/instance/config/agents/{name}/availability

Operation
config_agents.set_availability
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:write
Rights
agent.write
Effect
changing
Rate class
write

Parameters

  • name string in path, required

Request body

application/json: SetConfigAgentAvailabilityRequest

Answers

  • 200 The result

    application/json: AgentAvailability

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List agents and skills with their revisions

Section titled “List agents and skills with their revisions”

GET /api/v1/instance/config/assets

Operation
config_assets.get_overview
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:read
Rights
agent.read, skill.read
Effect
reading
Rate class
read

Answers

  • 200 The result

    application/json: ConfigAssetsOverview

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read one agent or skill

Section titled “Read one agent or skill”

GET /api/v1/instance/config/assets/{kind}/{name}

Operation
config_assets.get
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:read
Effect
reading
Rate class
read

Parameters

  • kind string in path, required
  • name string in path, required

Answers

  • 200 The result

    application/json: ConfigAsset

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Create or replace one agent or skill

Section titled “Create or replace one agent or skill”

PUT /api/v1/instance/config/assets/{kind}/{name}

Operation
config_assets.put
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:write
Effect
changing
Rate class
write

Parameters

  • kind string in path, required
  • name string in path, required

Request body

application/json: PutConfigAssetRequest

Answers

  • 200 The result

    application/json: PutConfigAssetResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Delete one agent or skill

Section titled “Delete one agent or skill”

POST /api/v1/instance/config/assets/{kind}/{name}/delete

Operation
config_assets.delete
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:write
Effect
changing
Rate class
write

Parameters

  • kind string in path, required
  • name string in path, required

Request body

application/json: ConfigAssetMutationVersionRequest

Answers

  • 200 The result

    application/json: ConfigAssetMutationVersionResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Restore an earlier revision of one agent or skill

Section titled “Restore an earlier revision of one agent or skill”

POST /api/v1/instance/config/assets/{kind}/{name}/revert

Operation
config_assets.revert
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:write
Effect
changing
Rate class
write

Parameters

  • kind string in path, required
  • name string in path, required

Request body

application/json: RevertConfigAssetRequest

Answers

  • 200 The result

    application/json: PutConfigAssetResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the revisions of one agent or skill

Section titled “List the revisions of one agent or skill”

GET /api/v1/instance/config/assets/{kind}/{name}/revisions

Operation
config_assets.revisions.list
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:read
Effect
reading
Rate class
read

Parameters

  • kind string in path, required
  • name string in path, required
  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Set or clear the default agent

Section titled “Set or clear the default agent”

PUT /api/v1/instance/config/default-agent

Operation
config_agents.set_default
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:write
Rights
agent.write
Effect
changing
Rate class
write

Request body

application/json: SetDefaultConfigAgentRequest

Answers

  • 200 The result

    application/json: ConfigAssetMutationVersionResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Export every agent and skill as one bundle

Section titled “Export every agent and skill as one bundle”

GET /api/v1/instance/config/export

Operation
config_assets.export
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:read
Rights
agent.read, skill.read
Effect
reading
Rate class
read

Answers

  • 200 The result

    application/json: ExportConfigAssetsResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Apply a bundle of agents and skills from a release

Section titled “Apply a bundle of agents and skills from a release”

POST /api/v1/instance/config/import

Operation
config_assets.replace
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:release
Rights
assets.release
Effect
changing
Rate class
write

Request body

application/json: ReplaceConfigAssetsRequest

Answers

  • 200 The result

    application/json: ReplaceConfigAssetsResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Check a bundle of agents and skills without applying it

Section titled “Check a bundle of agents and skills without applying it”

POST /api/v1/instance/config/validate

Operation
config_assets.validate
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:release
Rights
assets.release
Effect
reading
Rate class
read

Request body

application/json: ConfigAssetBundle

Answers

  • 200 The result

    application/json: ValidateConfigAssetsResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the Shared Workspaces an agent can be made available in

Section titled “List the Shared Workspaces an agent can be made available in”

GET /api/v1/instance/workspaces

Operation
instance.workspaces.list
Accepts
sessionCookie, sessionToken, accessToken
Scope
config_assets:write
Rights
agent.write
Effect
reading
Rate class
read

Parameters

  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.