Skip to main content
POST
Start Agent
Send a message to a Gumloop agent and start an asynchronous interaction. Returns immediately with an interaction_id that you use to poll for results. To continue an existing conversation, pass the interaction_id from a previous run. The new message is appended to that conversation’s history and the same interaction_id is reused. See Continuing a Conversation below.

Request

Headers

Body Parameters

string
required
The unique identifier of the agent to trigger. See Finding Your Agent ID below.
string
required
The message/prompt to send to the agent. This is a natural language string, not structured inputs.
string
Your Gumloop user ID. Required if project_id is not provided.
string
Your team (workspace) ID. Required if user_id is not provided. Can be combined with user_id.
string
The interaction_id from a previous interaction. When provided, the new message is appended to the existing conversation and the same interaction_id is reused. The previous interaction must be IDLE, COMPLETED, FAILED, or waiting on an approval (APPROVAL_REQUIRED).

Example Request

Response

Success (202 Accepted)

string
Unique identifier for this interaction. Use this to poll for results via the Retrieve Agent Status endpoint.
string
Always "processing" on success, indicating the agent has started working.

Error Responses


Finding Your Agent ID

The gummie_id is the unique identifier for your Gumloop agent. You can find it from the URL when viewing your agent:
For example, if your URL is https://www.gumloop.com/agents/abc123DEFghiJKL, then your gummie_id is abc123DEFghiJKL. You can also find the agent ID on the agent’s settings/configuration page in the Gumloop app.

Complete Workflow

After starting an agent interaction, poll for results:
See the Retrieve Agent Status endpoint for full details on polling and response schemas.

Continuing a Conversation

To continue an existing conversation, include the interaction_id from a previous run in your request body. The agent receives the full prior message history plus your new message, so it can respond with awareness of the earlier context.

Requirements

  • The previous interaction must be IDLE, COMPLETED, FAILED, or waiting on an approval (APPROVAL_REQUIRED)
  • The gummie_id must match the agent that owns the interaction
  • The caller must have access to the interaction

Continuation Flow

Example: Multi-Turn Conversation


Full Example: Start and Poll


Authentication Notes

  • You can use either a Personal API Key or a Team API Key. See Authentication for details.
  • If you authenticate with a personal API key and pass both user_id and project_id, the system verifies you are a member of the specified team before allowing the request.
  • The agent uses the credentials associated with the user_id and project_id provided in the request.
The Python and JavaScript SDKs do not yet support agent triggering. Use the raw HTTP examples above until SDK support is added.