Skip to main content
POST
/
v1
/
analyses
Create Analysis
curl --request POST \
  --url https://api.example.com/v1/analyses/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "urls": [
    "<string>"
  ],
  "structured_prompts": {
    "ids": [
      "prompt_01h45ytscbebyvny4gc8cr8ma2"
    ],
    "definitions": [
      {
        "name": "<string>",
        "description": "Extracts what a company does and whether it is generalist or specialist.",
        "prompt": "Given the page content, answer the questions according to the schema.",
        "response_schema": {
          "draft_07": {
            "enum": [
              "generalist",
              "specialist"
            ],
            "type": "string"
          }
        }
      }
    ]
  },
  "description": "<string>",
  "config": {
    "normalize_input_to_domains": true,
    "max_pages": 5
  }
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "owner": "<string>",
    "prompts": {
      "count": 123,
      "ids": [
        {
          "id": "<string>",
          "idx": 123
        }
      ]
    },
    "urls": {
      "count": 123,
      "urls": [
        "<string>"
      ]
    },
    "created_at": 123,
    "description": "<string>"
  },
  "response_type": "AnalysisCreateResponse",
  "links": []
}

Authorizations

X-API-Key
string
header
required

API Key for external integrations (format: greetincs_...)

Body

application/json

Request schema for creating analysis with URLs and structured prompts.

name
string
required
Required string length: 1 - 255
urls
string[]
required

List of URLs to analyze

Minimum array length: 1
structured_prompts
StructuredPromptInput · object
required

Input for structured prompts - either refs or full definitions.

description
string | null
Maximum string length: 1000
config
AnalysisConfigInput · object

Optional workflow configuration. If not provided, defaults are used.

Response

Successful Response

Basic analysis API response.

data
AnalysisCreateData · object
required

Basic analysis creation data.

response_type
string
default:AnalysisCreateResponse

HATEOAS links related to this response (e.g., self, next, prev)

Example:
[
{
"href": "/resource/{resource_id}",
"method": "GET",
"rel": "self",
"title": "Resource Details"
},
{
"href": "/resource/{resource_id}/related",
"method": "GET",
"rel": "related",
"title": "Related Resources"
}
]