{"_id":"55abe40fa36ccd0d00fdebe6","__v":0,"user":"55a7ae50bf1be93100d89df1","parentDoc":null,"project":"55a7aee84a33f92b00b7a150","editedParams":true,"category":{"_id":"55abddeaa36ccd0d00fdebe1","__v":2,"version":"55a7aee84a33f92b00b7a153","pages":["55abdf610685ce0d0049fbbb","55abe40fa36ccd0d00fdebe6"],"project":"55a7aee84a33f92b00b7a150","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-19T17:27:06.336Z","from_sync":false,"order":3,"slug":"batch-processing","title":"Batch Processing"},"editedParams2":true,"version":{"_id":"55a7aee84a33f92b00b7a153","__v":6,"project":"55a7aee84a33f92b00b7a150","createdAt":"2015-07-16T13:17:28.411Z","releaseDate":"2015-07-16T13:17:28.411Z","categories":["55a7aee94a33f92b00b7a154","55a7fefa3efe0c2f0074cbdf","55a8fb10c8bd450d000dd130","55a936b1cf45e1390093f362","55abddeaa36ccd0d00fdebe1","5624db675a86b423009462e1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-19T17:53:19.183Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl \"http://api.aylien.com/api/v1/queue?uuid=4ea6cc80-7874-4662-b496-7404b84576b8\" \\\n   -H \"X-AYLIEN-TextAPI-Application-Key: [[app:key]]\" \\\n   -H \"X-AYLIEN-TextAPI-Application-ID: [[app:id]]\"","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"status\": \"completed\",\n  \"location\": \"https://textapi-batch-results.s3.amazonaws.com/4ea6cc80-7874-4662-b496-7404b84576b8.xml?Expires=1437932527&AWSAccessKeyId=AKIAIGWKC4GNGXJBEIIQ&Signature=m5KywGxDVk6DhK26uJfYALufBGs%3D\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55abdf610685ce0d0049fbbf","ref":"","in":"query","required":false,"desc":"UUID of the job (provided by `/batch`)","default":"","type":"string","name":"uuid"}],"url":"/queue"},"isReference":false,"order":1,"body":"The **Queue** endpoint can be used to retrieve the status of a batch job (`pending`, `in-progress`, `failed`, or `completed`) and when the job is finished, to get a download link for the results.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Premium feature\",\n  \"body\": \"Batch Processing is a premium feature, meaning it's only available to our paid users at the moment. If you would like to trial it please [drop us a line](mailto:support:::at:::aylien.com).\"\n}\n[/block]","excerpt":"/queue","slug":"queue","type":"endpoint","title":"Retrieve Status/Results"}

getRetrieve Status/Results

/queue

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

uuid:
string
UUID of the job (provided by `/batch`)

Examples


Result Format


Documentation

The **Queue** endpoint can be used to retrieve the status of a batch job (`pending`, `in-progress`, `failed`, or `completed`) and when the job is finished, to get a download link for the results. [block:callout] { "type": "info", "title": "Premium feature", "body": "Batch Processing is a premium feature, meaning it's only available to our paid users at the moment. If you would like to trial it please [drop us a line](mailto:support@aylien.com)." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}