Skip to main content
POST
/
api
/
ai
/
v1
/
extract
curl --request POST \
  --url https://{subdomain}.domo.com/api/ai/v1/extract \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "input": [
    {
      "type": "TEXT",
      "text": "Contact: Sarah Johnson, email sarah.j@company.com, phone (555) 123-4567"
    }
  ],
  "outputStructure": {
    "name": {
      "type": "string",
      "description": "Full name"
    },
    "email": {
      "type": "string",
      "description": "Email address"
    },
    "phone": {
      "type": "string",
      "description": "Phone number"
    }
  }
}
'
{
  "output": {
    "name": "John Smith",
    "title": "Senior Software Engineer",
    "email": "john.smith@email.com",
    "phone": "(555) 123-4567",
    "experience": [
      {
        "company": "Tech Corp",
        "years": "2020-Present",
        "role": "Led microservices architecture serving 5M+ users"
      },
      {
        "company": "StartupXYZ",
        "years": "2016-2019",
        "role": "Built RESTful APIs with Spring Boot"
      }
    ],
    "education": "B.S. Computer Science, UC Berkeley, 2016",
    "skills": [
      "Java",
      "Python",
      "AWS",
      "Docker",
      "Kubernetes"
    ]
  },
  "model": "domo.domo_ai.domogpt-medium-v2.1:anthropic",
  "isCustomerModel": false,
  "requestId": "613f0d20-661a-48c4-a495-60cae524e8f6"
}

Documentation Index

Fetch the complete documentation index at: https://domoinc-arun-raj-connetors-domo-480645-add-reports-sort-asc.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Body

application/json

Request for extracting structured data from unstructured text using the Messages API.

The ExtractData service uses LLM structured outputs to extract data conforming to a provided JSON schema from message content input.

​
input
object[]
required

The input message content to extract data from (text, images, documents, etc.)

Text-based message content.

​
outputStructure
object
required

Map of field names to their FunctionParameter definitions. All fields are treated as required.

​
instructions
string

Optional instructions for extraction behavior

​
model
string

The ID of the model to use (optional, uses default if not specified)

​
modelConfiguration
object

Additional model parameters (temperature, max_tokens, etc.)

​
sessionId
string<uuid>

AI session ID for associating with existing session

​
reasoningConfig
object

Configuration for reasoning behavior

Response

Successful extract data response.

Response containing extracted structured data.

The output field contains a Map representation of the extracted data matching the schema provided in the request.

​
output
object
required

The extracted structured data as a Map

​
model
string

The model ID used for extraction

​
requestId
string<uuid>

The request identifier

​
isCustomerModel
boolean

Whether a customer-provided model was used

​
modelProviderUsage
object