Skip to main content
POST
Create a Custom Agent

Authorizations

x-auth-token
string
header
required

For server-to-server or automated access, use a DataGOL Service Account key. Pass it via the x-auth-token header instead of Authorization: x-auth-token: <service-account-key>

Body

application/json
uiMetadata
object
required
configs
object
required
isPublished
boolean
required

false = draft, creator only. true = published, shared users can access.

Example:

false

prompt
string
required

System prompt injected at the start of every conversation. The core instruction set — be specific about role, output format, and behavior.

Example:

"Scan this document and extract all key metrics, numbers, and quantitative statements. Organize them into a structured table."

description
string
required

Short description of what the agent does. Shown in the agent card.

Example:

"This Agent Details you through the Complete financial related Data"

name
string
required

Display name of the agent. Shown in the agent list and chat header.

Example:

"Financial Agent"

Response

Agent created successfully.

id
string<uuid>
name
string
description
string
prompt
string
instructions
string
examples
string
isPublished
boolean
skills
object[]
uiMetadata
object
configs
object
createdAt
string<date-time>
updatedAt
string<date-time>