GPTMaker icon

GPTMaker

Consume GPTMaker API

Agent → Conversation

AI-generated

Summary

POST /v2/agent/{agentId}/conversation initiating a chat with required context and prompt, optionally including callback/chat metadata.

Inputs

  • agentId (required) — Select the agent. Choose from the list, or specify an ID using an expression.
  • conversationContextId (required) — Context ID required by conversation endpoint
  • conversationPrompt (required) — Prompt/message to send to the agent (conversation)
  • callbackUrl — Optional callback URL to receive asynchronous updates
  • onFinishCallback — Optional callback URL to be called when the conversation finishes
  • chatName — Optional chat display name
  • chatPicture — Optional chat picture URL
  • phone — Optional phone number associated with the chat

Output shape

API response from POST /v2/agent/{agentId}/conversation, typically containing conversation/chat identification and status.

Only non-empty optional fields (callbackUrl, onFinishCallback, chatName, chatPicture, phone) are included in the request body.

Examples

Example 1: Basic conversation start

agentId selected from list; conversationContextId and conversationPrompt provided; all optional fields left empty.

Links

Discussion