> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Markup AI

> Markup AI provides content agents, brand terminology, personas, brand voice profiles, and style configuration for evaluating and improving content.

![Markup AI logo](https://mintcdn.com/composio-preview/ufpARLIsio16odJB/images/toolkits/markup_ai.svg?fit=max\&auto=format\&n=ufpARLIsio16odJB\&q=85\&s=d445a95ffbf31e19cb48c30b6e4d4774)

* **Category:** artificial intelligence
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `MARKUP_AI`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Agent
>
> **Slug:** `MARKUP_AI_GET_AGENT`
>
> Get one agent's metadata by ID, including its runtime input and output JSON Schemas when available.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Stable agent ID returned by LIST\_AGENTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Analysis Profile
>
> **Slug:** `MARKUP_AI_GET_ANALYSIS_PROFILE`
>
> Get one persona, brand voice profile, style target, or style guide by ID, including detailed configuration needed to understand its effect on analysis. Style details can contain a large hierarchy of goals, groups, and guidelines.
>
> #### Input Parameters
>
> **profile\_id** `string` *required*
>
> Profile ID returned by LIST\_ANALYSIS\_PROFILES for the same profile\_type.
>
> **profile\_type** `string ("persona" | "brand_voice" | "style_target" | "style_guide")` *required*
>
> Kind of profile identified by profile\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workflow
>
> **Slug:** `MARKUP_AI_GET_WORKFLOW`
>
> Get the current status and result of an asynchronous agent workflow by ID.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Workflow ID returned by RUN\_AGENT or LIST\_WORKFLOWS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Agent Categories
>
> **Slug:** `MARKUP_AI_LIST_AGENT_CATEGORIES`
>
> Return all agent categories available to the connected organization for discovery and agent-list filtering.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Agents
>
> **Slug:** `MARKUP_AI_LIST_AGENTS`
>
> Discover Markup AI agents available to the connected organization, optionally filtered by category. Returns compact summaries for choosing an agent; use GET\_AGENT for its full runtime schemas.
>
> #### Input Parameters
>
> **category** `string`
>
> Category name substring used to filter available agents case-insensitively; discover names with LIST\_AGENT\_CATEGORIES.
>
> **page\_size** `integer`
>
> Maximum agents to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Analysis Profiles
>
> **Slug:** `MARKUP_AI_LIST_ANALYSIS_PROFILES`
>
> List selectable persona, brand voice, style guide, style target, or content profile resources used to configure agent runs.
>
> #### Input Parameters
>
> **profile\_type** `string ("persona" | "brand_voice" | "style_target" | "style_guide" | "content_profile")` *required*
>
> Kind of analysis configuration to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Terminology Resources
>
> **Slug:** `MARKUP_AI_LIST_TERMINOLOGY_RESOURCES`
>
> List terminology term sets or domains with filters and cursor-controlled pagination.
>
> #### Input Parameters
>
> **search** `string`
>
> Name or text filter. Sent as search\_term for term sets and search for domains.
>
> **page\_size** `integer`
>
> Maximum resources to return in this page.
>
> **domain\_ids** `array`
>
> For term\_set only, return term sets linked to any of these domains.
>
> **has\_context** `boolean`
>
> For term\_set only, filter by whether a term set has non-empty conditional context.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **resource\_type** `string ("term_set" | "domain")` *required*
>
> Terminology resource to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workflows
>
> **Slug:** `MARKUP_AI_LIST_WORKFLOWS`
>
> List one cursor-controlled page of agent execution workflows, optionally filtering by status, stable agent name, or creation time. Repeat the agent name on subsequent pages to retain that filter.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum workflows to return in this page.
>
> **status** `string ("running" | "completed" | "failed" | "cancelled" | "timed_out" | "terminated")`
>
> Workflow status to return.
>
> **agent\_name** `string`
>
> Only return workflows whose agent\_id field equals this stable agent name, such as 'sentence\_clarity'. Repeat agent\_name with next\_cursor to keep filtering later pages; status, created\_after, and limit are carried by the cursor automatically.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **created\_after** `string`
>
> Only return workflows created after this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Agent
>
> **Slug:** `MARKUP_AI_RUN_AGENT`
>
> Run one selected Markup AI agent against document text, synchronously or asynchronously. Discover the agent and inspect its schema first; execution may consume organization quota. The persona agent requires persona\_id at runtime even when its advertised input schema marks only text as required.
>
> #### Input Parameters
>
> **url** `string`
>
> Source URL associated with the document.
>
> **goal** `string`
>
> Document goal supplied to agents that support goal-based recommendations.
>
> **text** `string` *required*
>
> Non-empty document text to analyze (maximum 100,000 characters).
>
> **wait** `boolean`
>
> If true, wait for completion; if false, return a workflow ID immediately for GET\_WORKFLOW.
>
> **agent\_id** `string` *required*
>
> Agent ID returned by LIST\_AGENTS.
>
> **domain\_ids** `array`
>
> Terminology domain IDs to apply.
>
> **persona\_id** `string`
>
> Persona profile ID required when running the persona agent. Discover available IDs with LIST\_ANALYSIS\_PROFILES using profile\_type='persona'.
>
> **webhook\_url** `string`
>
> Webhook URL for asynchronous result delivery.
>
> **document\_ref** `string`
>
> Caller-provided document identifier for tracking scans.
>
> **document\_name** `string`
>
> Document name or title.
>
> **style\_guide\_id** `string`
>
> Style guide ID to apply; use this canonical field rather than the provider's deprecated target\_id alias.
>
> **voice\_profile\_id** `string`
>
> Brand voice profile ID used by the brand\_voice agent.
>
> **content\_profile\_id** `string`
>
> Content profile ID for style checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Terminology
>
> **Slug:** `MARKUP_AI_SEARCH_TERMINOLOGY`
>
> Find organization terminology rules relevant to supplied text, optionally limited to selected domains.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text to scan for relevant preferred or prohibited terminology.
>
> **domain\_ids** `array`
>
> Optional terminology domain IDs used to limit matches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
