research

Get study designs (v3)

Supports original MP3 and WAV audio alongside the existing study media. Read the instrument or honest unsupported outcome prepared by this member or API key under its study-design request Idempotency-Key. Returns pending, ready, or failed without another model call. A different caller's design is not found.

get/api/v1/research/study-designs-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/study-designs-v3/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

The Idempotency-Key of the research.study-designs.start request.

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

runIdstring uuid required

The billing run that pays for the design in Alpha credits.

status'pending' | 'failed' | 'ready' required
failureDisposition'transient' | 'repairable_schema' | 'deterministic' | 'cancelled' | 'unknown' | 'repairable_domain'

Why a failed design stopped, once its run settled: transient is worth retrying; deterministic and repairable_schema need a changed request.

Changes

No recorded changes to this operation across all 1 revision of this API.