Sign in

v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_GradientAI Platform

Update Agent Status

Check whether an agent is public or private. To update the agent status, send a PUT request to /v2/gen-ai/agents/{uuid}/deployment_visibility.

put/v2/gen-ai/agents/{uuid}/deployment_visibility

Path parameters

uuidstring required

Unique id

Request body

uuidstring

Unique id

visibility'VISIBILITY_UNKNOWN' | 'VISIBILITY_DISABLED' | 'VISIBILITY_PLAYGROUND' | 'VISIBILITY_PUBLIC' | 'VISIBILITY_PRIVATE'
  • VISIBILITY_UNKNOWN: The status of the deployment is unknown
  • VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
  • VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
  • VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
  • VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys

Example request

{
  "uuid": "\"12345678-1234-1234-1234-123456789012\"",
  "visibility": "VISIBILITY_UNKNOWN"
}

Response

A successful response.