Queries

Create a query

Escrows (bid + bonus) x required_responses plus the 15% platform fee and dispatches to matched human workers. With a test-mode key nothing is charged and up to 10 synthetic responses (marked simulated: true, max 50/day per account) are injected. Rate limits by account tier: trial (no completed deposit yet) 10 creations/min and 100/day; standard 60/min; high-volume 300/min. GET /requestor/usage reports your tier and limits.

post/requestor/queries

Request

  • Base URL: https://www.getabrain.ai/api/v1
  • URL: https://www.getabrain.ai/api/v1/requestor/queries
  • Auth: one of:
    • API key in header X-API-Key and API key in header X-API-Secret
    • HTTP bearer

Request body

type'text' | 'multiple_choice' | 'rating_scale' | 'image_comparison' | 'ranking' | 'yes_no' | 'sentiment' | 'image_selection' | 'free_form_text' | 'video_review' | 'audio_review' | 'image_analysis' | 'ab_test' | 'voice_capture' | 'video_capture' | 'photo_capture' required
titlestring required
descriptionstring
required_responsesinteger required
bid_amount_centsinteger required

Payment per response in cents. The minimum is effort-priced PER TYPE (absolute floor 5; e.g. yes_no/multiple_choice/sentiment 5, image_comparison 8, text/ranking/image_analysis 12, free_form_text/video_capture 30; video_review/audio_review scale with clip length). Call GET /requestor/suggested-bid?type=<type> for min_bid_cents + suggested_bid_cents; a bid under the floor is rejected with 400. A 15% platform fee is added on top of bid x required_responses.

bonus_amount_centsinteger
min_worker_qualitynumber
required_languagesstring[]
required_location_countriesstring[]
required_skillsstring[]
excluded_worker_idsstring[]
expires_in_hoursinteger

Hours until the query auto-expires (default 72, max 168). Unfilled response slots are refunded to your balance on expiry.

webhook_urlstring uri

Per-query override: public https URL to receive signed response.submitted / query.completed events

Response

Query created (status "active", or "moderation_hold" with an explanatory "message" field if the content was flagged for review — the bid is escrowed either way). test_mode is true for queries created with a test-mode key.

idstring uuid
typestring
titlestring
descriptionstring
required_responsesinteger
completed_responsesinteger
bid_amount_centsinteger
bonus_amount_centsinteger
total_cost_centsinteger
status'pending' | 'active' | 'moderation_hold' | 'completed' | 'cancelled' | 'failed' | 'expired' | 'rejected'
created_atstring date-time
expires_atstring date-time nullable
test_modeboolean
messagestring

Changes

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