MOmodjo
Agents

Get an agent

Changed on

Returns a single agent by UUID, including its instructions.

get/agents/{uuid}

Request

  • Base URL
    https://api.modjo.ai/v2
  • URL
    https://api.modjo.ai/v2/agents/{uuid}
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

Agent UUID

Example:3f2b8c1e-7d4a-4e5b-9c6f-1a2b3c4d5e6f

Response

Agent details

uuidstring uuid required

Agent UUID

namestring required

Agent name

emojistring required

Agent emoji

descriptionstring required

Short description of what the agent does

instructionsstring required

Instructions the AI follows when the agent is used

creatorOrigin'modjo' | 'user' required

Origin of the agent: modjo for agents provided by Modjo, which are read-only, user for agents created in your workspace

enabledToolsstring[] required

Tools the agent can use

createdByIdnumber nullable required

ID of the user who created the agent

createdOnstring nullable required

Creation timestamp in ISO 8601 format

modifiedOnstring nullable required

Last modification timestamp in ISO 8601 format

Example response

{
  "uuid": "3f2b8c1e-7d4a-4e5b-9c6f-1a2b3c4d5e6f",
  "name": "Discovery coach",
  "emoji": "🧭",
  "description": "Reviews discovery calls against the MEDDIC framework.",
  "instructions": "For each call, list the MEDDIC criteria that were covered and the ones that are still missing.",
  "creatorOrigin": "user",
  "enabledTools": [
    "websearch"
  ],
  "createdById": 42,
  "createdOn": "2024-06-15T14:30:00.000Z",
  "modifiedOn": "2024-06-15T15:00:00.000Z"
}

Changes