Get a Research job
GET
/v1/research/jobs/{id}Path parameters
idstring<uuid>requiredResponses
200Safe Research lifecycle projection
dataobjectrequiredShow propertiesHide properties
Any of:
object
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
quotedcache_dispositionstringrequiredAllowed:
live_fetchreserved_creditsnumberrequiredAllowed:
0quote_idstring<uuid>requiredexpires_atstring<date-time>requiredobject
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
waiting_cachecache_dispositionstringrequiredAllowed:
cache_joinreserved_creditsnumberrequiredAllowed:
0object
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
queuedcache_dispositionstringrequiredAllowed:
live_fetchreserved_creditsintegerrequiredmin 0 · max 1000000000
object
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
processingcache_dispositionstringrequiredAllowed:
live_fetchreserved_creditsintegerrequiredmin 0 · max 1000000000
started_atstring<date-time>requiredobject
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
succeededcache_dispositionstringrequiredAllowed:
cache_hitcache_joinlive_fetchcache_stalereserved_creditsintegerrequiredmin 0 · max 1000000000
settled_creditsintegerrequiredmin 0 · max 1000000000
completed_atstring<date-time>requiredresult_readybooleanrequiredAllowed:
trueobject
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
failedcache_dispositionstringrequiredAllowed:
cache_joinlive_fetchreserved_creditsintegerrequiredmin 0 · max 1000000000
settled_creditsnumberrequiredAllowed:
0completed_atstring<date-time>requirederrorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
research_failednormalization_failedmessagestringrequiredAllowed:
Research request failedResearch result could not be normalizedobject
schema_versionstringrequiredAllowed:
research-job@1kindstringrequiredAllowed:
research_jobidstring<uuid>requiredcapability_idstringrequiredAllowed:
research.facebook-company-ads@1maximum_creditsintegerrequiredmin 0 · max 1000000000
created_atstring<date-time>requiredupdated_atstring<date-time>requiredstatusstringrequiredAllowed:
unknowncache_dispositionstringrequiredAllowed:
cache_joinlive_fetchreserved_creditsintegerrequiredmin 0 · max 1000000000
reconciliation_requiredbooleanrequiredAllowed:
true404Job absent or outside the exact API-key workspace boundary
errorobjectrequiredShow propertiesHide properties
codestringrequiredmin length 1 · max length 128
messagestringrequiredmin length 1 · max length 2000
retryablebooleanrequiredrequest_idstring<uuid>requiredbalanceintegermin 0
requiredintegermin 0
fieldstringmin length 1 · max length 512
statestringmin length 1 · max length 128
retryWithNewKeybooleanparameterstringmin length 1 · max length 128
allowedstring[]max items 100
503Research authority or projection unavailable
errorobjectrequiredShow propertiesHide properties
codestringrequiredmin length 1 · max length 128
messagestringrequiredmin length 1 · max length 2000
retryablebooleanrequiredrequest_idstring<uuid>requiredbalanceintegermin 0
requiredintegermin 0
fieldstringmin length 1 · max length 512
statestringmin length 1 · max length 128
retryWithNewKeybooleanparameterstringmin length 1 · max length 128
allowedstring[]max items 100
Request
curl -X GET "https://api.roasos.com/v1/research/jobs/%3Cuuid%3E"const response = await fetch("https://api.roasos.com/v1/research/jobs/%3Cuuid%3E", {
method: "GET"
});import requests
response = requests.get(
"https://api.roasos.com/v1/research/jobs/%3Cuuid%3E",
)Response
{
"data": {
"schema_version": "research-job@1",
"kind": "research_job",
"id": "<uuid>",
"capability_id": "research.facebook-company-ads@1",
"maximum_credits": 0,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"status": "quoted",
"cache_disposition": "live_fetch",
"reserved_credits": 0,
"quote_id": "<uuid>",
"expires_at": "2024-01-01T00:00:00Z"
}
}{
"error": {
"code": "string",
"message": "string",
"retryable": true,
"request_id": "<uuid>",
"balance": 0,
"required": 0,
"field": "string",
"state": "string",
"retryWithNewKey": true,
"parameter": "string",
"allowed": [
"string"
]
}
}{
"error": {
"code": "string",
"message": "string",
"retryable": true,
"request_id": "<uuid>",
"balance": 0,
"required": 0,
"field": "string",
"state": "string",
"retryWithNewKey": true,
"parameter": "string",
"allowed": [
"string"
]
}
}