POST /v2/gen-ai/agents
To create a new agent, send a POST request to /v2/gen-ai/agents. The response body contains a JSON object with the newly created agent object.
Servers
- https://api.digitalocean.com
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 |
|---|---|---|---|
open_ai_key_uuid |
String | No |
Optional OpenAI API key ID to use with OpenAI models |
knowledge_base_uuid[] |
Array | No |
Ids of the knowledge base(s) to attach to the agent |
region |
String | No |
The DigitalOcean region to deploy your agent in |
project_id |
String | No |
The id of the DigitalOcean project this agent will belong to |
name |
String | No |
Agent name |
description |
String | No |
A text description of the agent, not used in inference |
anthropic_key_uuid |
String | No |
Optional Anthropic API key ID to use with Anthropic models |
tags[] |
Array | No |
Agent tag to organize related resources |
instruction |
String | No |
Agent instruction. Instructions help your agent to perform its job effectively. See Write Effective Agent Instructions for best practices. |
model_uuid |
String | No |
Identifier for the foundation model. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.