How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Viewpoints AI Studies API

Create studies and retrieve results

Viewpoints AI Studies API is one of 3 APIs that Viewpoints AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Studies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against the base URL https://api.viewpoints.ai.

4 operations 3 paths 17 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.viewpoints.ai
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Viewpoints AI Studies API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (apiKey). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Studies 4

Create studies and retrieve results

POST
/v1/studies
Create a new study
post__v1_studies body → 200400401402403
GET
/v1/studies/jobs/{job_id}
Get study creation job status
get__v1_studies_jobs_{job_id} 1 param → 200202400401404
GET
/v1/studies/{id}
Get study results
get__v1_studies_{id} 1 param → 200400401403404
PUT
/v1/studies/{id}
Replace a draft study
put__v1_studies_{id} 1 param body → 200400401402403404409

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are JobStatusResponse (24 properties), StudyDetailsResponse (19 properties), CreateStudyRequest (16 properties), GetStudyResponse (9 properties). Each schema is shown below with its type and property counts.

QuestionItem
object
8 properties 3 required
CreateStudyRequest
object
16 properties 11 required
UploadedMediaItem
object
Media stimulus to be included in the study
4 properties 2 required
StudyDetailsResponse
object
19 properties 8 required
StimulusItem
object
5 properties 3 required
CaptionResponse
object
3 properties 2 required
AgeParametersItem
object
5 properties 2 required
SegmentItem
object
2 properties 2 required
CreateStudyResponse
object
3 properties 1 required
ParticipantResultItem
object
8 properties 7 required
ErrorResponse
object
2 properties 1 required
SegmentSubCategoryItem
object
2 properties 2 required
MediaItem
object
Media item that can be either a URL string or an object with url/type/name.
3 properties 1 required
TextCaptionItem
object
Text stimulus to be included in the study
4 properties 1 required
GetStudyResponse
object
9 properties 5 required
AssignedMaterialsItem
object
2 properties 2 required
JobStatusResponse
object
24 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

viewpoints-ai-studies-api-openapi.yml Raw ↑

Other APIs Viewpoints AI publishes across the network.

Viewpoints AI Study File Uploads API
Viewpoints AI Study Schedules API
Where this information came from

This is an independent, third-party profile of Viewpoints AI Studies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.