Skip to main content

Overview

Prerequisites:
  • This feature is available on workspaces with DinoAI programmable agents enabled.
  • Your API keys must have access to the DinoAI Agents API.
These examples authenticate with an account API key (api_secret="prdm_cmp_..." plus workspace_uid), which requires paradime-io 6.0.0 or later. Legacy workspace API keys (api_key + api_secret) are still supported. See Getting Started.
The DinoAI Agents module lets you drive DinoAI programmable agents from Python. This module offers a comprehensive set of tools to trigger agent runs from YAML-defined agents, send ad-hoc prompts, follow up on a live session with new messages, poll for run state, and block until a run completes.

Trigger an agent run

Triggers a DinoAI programmable agent run. At least one of agent or message must be provided.
agent (Optional[str]): Name of the YAML-defined agent to load (matches the file name under .dinoai/agents/ without the .yml extension).message (Optional[str]): Custom prompt appended to the agent’s context. When only agent is provided, the run starts with the agent’s role/goal/backstory.slack_channel (Optional[str]): Slack channel ID the run should post into (e.g. "C0123456789"). Must be provided together with slack_thread.slack_thread (Optional[str]): Slack thread timestamp the run should reply in (e.g. "1714142436.001200"). Must be provided together with slack_channel.
slack_channel and slack_thread must be supplied together — passing only one will be rejected by the API. Omit both to leave Slack routing to the agent’s YAML configuration (if any).

Trigger an agent run and wait for completion

Triggers a DinoAI agent run and blocks until it reaches COMPLETED or FAILED.
agent (Optional[str]): Name of the YAML-defined agent to load.message (Optional[str]): Custom prompt appended to the agent’s context.slack_channel (Optional[str]): Slack channel ID. Must be provided together with slack_thread.slack_thread (Optional[str]): Slack thread timestamp. Must be provided together with slack_channel.timeout (int): Maximum seconds to wait before raising TimeoutError. Defaults to 3600.poll_interval (int): Seconds between status polls. Defaults to 10.

Send a follow-up message

Sends a follow-up message to an active DinoAI agent session. The agent pod stays alive for up to 24 hours since the last message; follow-ups resume the same conversation with full context.
agent_session_id (str): The session ID of the running agent.message (str): The follow-up message to send.

Get an agent run

Fetches the current state of a DinoAI agent run.
agent_session_id (str): The session ID returned by trigger_run or send_message.