Skip to main content
PATCH
Update Analysis

Authorizations

X-API-Key
string
header
required

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

Path Parameters

analysis_id
string
required

Analysis ID in TypeID format

Body

application/json

Request schema for updating an analysis.

All fields are optional. At least one field must be provided.

name
string | null
Required string length: 1 - 255
description
string | null
Maximum string length: 1000
urls_add
string[] | null

URLs to add as new sub-analyses

sub_analysis_ids_remove
string[] | null

Sub-analysis IDs to mark as SKIPPED

structured_prompts
StructuredPromptInput · object | null

Replace all prompts with this list

config
AnalysisConfigInput · object | null

Replace analysis configuration

Response

Successful Response

Analysis with loaded prompt details and URLs.

data
AnalysisDescriptionData · object
required

Analysis detail data.

response_type
string
default:AnalysisDescriptionResponse

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

Example: