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"
}"<string>"Data Extraction - Beta
Extract structured data from unstructured text according to a provided JSON schema.
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"
}"<string>"Authorizations
Body
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.
The input message content to extract data from (text, images, documents, etc.)
Text-based message content.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Map of field names to their FunctionParameter definitions. All fields are treated as required.
Show child attributes
Show child attributes
Optional instructions for extraction behavior
The ID of the model to use (optional, uses default if not specified)
Additional model parameters (temperature, max_tokens, etc.)
Show child attributes
Show child attributes
AI session ID for associating with existing session
Configuration for reasoning behavior
Show child attributes
Show child attributes
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.