For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
      • Basic
      • Versioning and stability
      • Rate limits and API status
      • Account balance
      • API support
    • Users
    • Taskflow
    • AI Task Builder
    • Studies
    • Representative sample studies
    • Filter Sets
    • Participant Groups
    • Custom Groups
    • Study Distribution
    • Submissions
    • Submission Feedback Upload
    • Bonuses
    • Messages
    • Workspaces
    • Organisations
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
  • API Reference
  • Introduction
  • Basic
  • Versioning and stability
  • Rate limits and API status
  • Account balance
  • API support
  • Users
  • Retrieve a user
  • Create a test participant for a researcher
  • Taskflow
  • AI Task Builder
  • Batches
  • Exporting Batch Data
  • Collections
  • Exporting Collection Data
  • Datasets
  • Defining a Dataset Schema
  • Uploading Data
  • Setting up a Batch from a Schema Dataset
  • Configurable Layout
  • Instructions
  • List Batches
  • Create a Batch
  • Get a Batch
  • Update a Batch
  • Get Batch Status
  • Setup a Batch
  • Get Batch Responses
  • Get Batch Report
  • Duplicate a Batch
  • Request a Batch Export
  • Get Batch Export Status
  • Create a Dataset
  • Get a Dataset
  • Get Dataset Upload URL
  • Get Dataset Import Status
  • Get Dataset Status
  • Get Batch Instructions
  • Create Batch Instructions
  • Update Batch Instructions
  • List Collections
  • Create a Collection
  • Get a Collection
  • Update a Collection
  • Get Collection Responses
  • Request a Collection Export
  • Get Collection Export Status
  • Studies
  • The study object
  • List all studies
  • Create a draft study
  • List all studies in a project
  • Retrieve a study
  • Delete a study
  • Update a study
  • Transition a study's status
  • Create a test study
  • Get taskflow progress
  • Show Study cost
  • List study submissions
  • Count study submissions by status
  • Download credential usage report
  • Download demographic data
  • Export demographic data
  • Get demographic export history
  • Duplicate a study
  • Show Study predicted recruitment time
  • Show Study predicted recruitment time
  • Calculate the study cost
  • Representative sample studies
  • Available representative sample study types
  • Filters Overview
  • Advanced filtering
  • Study Distribution (Quotas) with Filters
  • List all filters
  • Get filter distribution
  • Count participants
  • Filter Sets
  • List all filter sets
  • Create filter set
  • Get filter set
  • Delete filter set
  • Update filter set
  • Clone filter set
  • Lock filter set for editing
  • Unlock filter set for editing
  • Participant Groups
  • Get a list of all participant groups within a project or workspace
  • Create a new participant group within a workspace
  • Get a participant group
  • Delete a participant group
  • Update a participant group
  • Get a list of all participants within a participant group
  • Add participants to a participant group
  • Remove participants from a participant group
  • Custom Groups
  • Study Distribution
  • Submissions
  • Submissions guide
  • Submission object
  • List submissions
  • Retrieve a submission
  • Approve or reject a submission
  • Request the participant who submitted the response to return their response
  • Bulk approve submissions
  • Submission Feedback Upload
  • Request a feedback upload URL
  • Bonuses
  • Set up bonuses
  • Pay bonuses
  • Messages
  • Retrieve messages
  • Send a message
  • Send a message to multiple participants
  • Send a message to a participant group
  • Retrieve unread messages
  • Workspaces
  • Get all a user's workspaces
  • Create a workspace
  • Get workspace
  • Update a workspace
  • Get the balance of a workspace
  • Get the cost breakdown of a workspace
  • Organisations
  • Get the cost breakdown of an organisation
  • Projects
  • Get all projects in a workspace
  • Create a project
  • Get project
  • Update a project
  • Surveys
  • Get all surveys
  • Create survey
  • Get survey
  • Delete survey
  • Get all responses
  • Create response
  • Delete all responses
  • Get summary of responses
  • Get response
  • Delete a response
  • Webhooks
  • Subscribing
  • Receiving
  • Event Delivery and Retry Logic
  • Persistent Failures and Disabling Logic
  • Idempotency and the X-Event-ID Header
  • Handling event order with X-Timestamp
  • Verifying
  • List all subscribable event types
  • List all secrets
  • Create/replace a secret
  • List all subscriptions
  • Create a subscription
  • Retrieve a subscription
  • Confirm a subscription
  • Delete a subscription
  • Update a subscription
  • Get subscription events
  • Invitations
  • Create a new invitation
  • Reward Recommendations
  • Calculate reward recommendations
  • Testing
  • Well Known Endpoints
  • Retrieve JSON Web Key Set (JWKS)
  • List credential pools for a workspace
  • Create credential pool
  • Update credential pool
Go to app
API ReferenceIntroduction

Account balance

|View as Markdown|Open in Claude|

Publishing studies requires an available balance in your account. You can only check your balance on our web application.

Was this page helpful?
Previous

Rate limits and API status

Next

API support