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

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.

Servers

Path parameters

Name Type Required Description
uuid String Yes

Unique id

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
visibility String No
  • 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

Possible values:

  • "VISIBILITY_DISABLED"
  • "VISIBILITY_PRIVATE"
  • "VISIBILITY_UNKNOWN"
  • "VISIBILITY_PUBLIC"
  • "VISIBILITY_PLAYGROUND"

Default value: "VISIBILITY_UNKNOWN"

uuid String No

Unique id

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.