Skip to main content
POST
/
converse
Python
from datagrid_ai import Datagrid

client = Datagrid(
    api_key="My API Key",
)
converse_response = client.converse(
    prompt="string",
)
print(converse_response.content)
{
  "object": "conversation.message",
  "id": "<string>",
  "agent_id": "<string>",
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "conversation_id": "<string>",
  "credits": {
    "consumed": 123
  },
  "citations": [
    {
      "citation": "<string>",
      "knowledges": [
        {
          "type": "image",
          "knowledge_id": "<string>",
          "confirmations": [
            "<string>"
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
prompt
required

A text prompt to send to the agent.

​
config
object

Override the agent config for this converse call. This is applied as a partial override.

​
agent_id
string | null

The ID of the agent that should be used for the converse.

​
conversation_id
string | null

The ID of the present conversation to use. If it's not provided - a new conversation will be created.

​
stream
boolean | null
default:false

Determines the response type of the converse. Response is the Server-Sent Events if stream is set to true.

​
generate_citations
boolean | null
default:false

Determines whether the response should include citations. When enabled, the agent will generate citations for factual statements.

​
secret_ids
string[] | null

Array of secret ID's to be included in the context. The secret value will be appended to the prompt but not stored in conversation history.

​
text
object | null

Contains the format property used to specify the structured output schema. Structured output is currently only supported by the default agent model, magpie-1.1.

Response

200 - application/json

Converse response

The conversation.message object represents a message in a conversation.

​
object
enum<string>
required

The object type, which is always conversation.message.

Available options:
conversation.message
​
id
string
required

The message identifier.

​
agent_id
string
required

The ID of the agent that sent or responded to the message.

​
role
enum<string>
required

The role of the message sender - either 'user' or 'agent'.

Available options:
user,
agent
​
content
object[]
required

Contents of the message.

​
created_at
string<date-time>
required

The ISO string for when the message was created.

​
conversation_id
string
required

The ID of the conversation the message belongs to.

​
credits
object
required
​
citations
object[]
required

Array of citations that provide knowledges for factual statements in the response. Each citation includes the referenced text and its knowledges.

⌘I