{"__v":4,"_id":"54d37180d0b2871900cda70e","category":{"__v":2,"_id":"55d697f9ae529e0d00d34f03","pages":["55d698c5d2a8eb1900109ec5","56e204d4059d4a0e0034fa90"],"project":"5476bf0f817e8d080031f988","version":"5476bf10817e8d080031f98b","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-21T03:16:09.287Z","from_sync":false,"order":9,"slug":"api-reference","title":"API REST end points"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"5476bf0f817e8d080031f988","user":"5476beec817e8d080031f986","version":{"__v":17,"_id":"5476bf10817e8d080031f98b","project":"5476bf0f817e8d080031f988","createdAt":"2014-11-27T06:05:04.263Z","releaseDate":"2014-11-27T06:05:04.263Z","categories":["5476bf10817e8d080031f98c","5477c46cf3736008009e9eb5","5477c474f3736008009e9eb6","5477c47ef3736008009e9eb7","5477c48ff3736008009e9eb8","5477c4948deb230800808bf0","54e68328154f8e0d0007b55c","54e90194c8e0c00d007ac061","54eed2275bf74a0d00ef4076","54f7a7be0a3cbb0d00d666fb","559b0ebf7ae7f80d0096d871","55d697f9ae529e0d00d34f03","562d4dcc8c6e5a0d00d6ed1d","562e591c4376430d006f17e0","568f0e73bdb9260d00149d8c","5719542aac1e2e0e001834c6","57a14a8ed778850e0047e230"],"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-02-05T13:34:56.456Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"import requests\nimport json\nimport autoprotocol as ap\n\n\n# Example protocol written with autoprotocol-python\np = ap.Protocol()\nplate = p.ref(\"plate\", id=None, cont_type=\"96-flat\", storage=None, discard=True)\np.cover(con)\np.spin(con, \"500:g\", \"60:second\")\n\n# End protocol\n\nheaders = {\"X-User-Email\": 'example:::at:::example.com',\n\n           \"X-User-Token\": '',  # Regular-mode API key\n\n           \"Content-Type\": \"application/json\",\n\n           \"Accept\": \"application/json\"}\n\nurl = 'https://secure.transcriptic.com/:organization/:project/runs'\n\n# Create the request body, note statement of test mode boolean\nbody = json.dumps(\n  {\n   \"title\": \"My first run\", \n   \"protocol\": p.as_dict(), \n   \"test_mode\": False\n  })\n\n# POST body to the run endpoint\nresponse = requests.post(url, body, headers=headers)","language":"python"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"id\": \"r17dgz2jfvped\",\n  \"status\": \"accepted\",\n  /* ... */\n}","language":"json","status":201},{"code":"{\n  \"protocol\": [\n    {\n      \"message\": \"Some error message\",\n      \"context\": \"root\"\n    }\n  ]\n}","language":"json","status":422}]},"settings":"","auth":"required","params":[{"_id":"54d371ae87ea950d00f1bcc2","ref":"","in":"path","required":true,"desc":"Your organization URL","default":"","type":"string","name":"organization"},{"_id":"54d371ae87ea950d00f1bcc1","ref":"","in":"path","required":true,"desc":"Your project URL","default":"","type":"string","name":"project"},{"_id":"55e7861fd3219b0d001d0c9b","ref":"","in":"body","required":true,"desc":"If submitting from a launch request this can be omitted.","default":"","type":"object","name":"protocol"},{"_id":"5719240ab69de4170047846e","ref":"","in":"body","required":false,"desc":"Optional: If programmatically launching a packaged protocol, you can provide the launch_request_id here.","default":"lrxxxxxxxxx","type":"string","name":"launch_request_id"}],"url":"/:organization/:project/runs"},"isReference":true,"order":2,"body":"A run is the ordered list of instructions that build upon another. The easiest way to create a run is to [launch a protocol](//developers.transcriptic.com/v1.0/docs/list-all-protocols), but you can also create them directly.\n\nThe `run` object that must be submitted in the POST body has the form:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"title\\\": \\\"My run title\\\",\\n  \\\"protocol\\\": {\\n    /* autoprotocol body with `ref` and `instruction` stanzas */\\n  },\\n  \\\"test_mode\\\": true /* or false */\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Submitting runs from packaged protocols via the API\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"This feature is experimental\"\n}\n[/block]\nIt is also possible to programmatically launch packaged protocols such as those reloaded into your organization or from any other packages uploaded to your organization.\n\nPrior to `POST`ing to this end point a launch_request_id must be obtained from the protocols `launch` endpoint.\n\nThe body of the request will look like below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"title\\\": \\\"My run title\\\",\\n  \\\"launch_request_id\\\": \\\"lrxxxxxxx\\\", /* a genuine launch request id */\\n  \\\"test_mode\\\": true /* or false */\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"create a run","slug":"create-a-run","type":"endpoint","title":"/runs"}

post/runs

create a run

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

organization:
required
string
Your organization URL
project:
required
string
Your project URL

Body Params

protocol:
required
object
If submitting from a launch request this can be omitted.
launch_request_id:
stringlrxxxxxxxxx
Optional: If programmatically launching a packaged protocol, you can provide the launch_request_id here.

Examples


Result Format


Documentation

A run is the ordered list of instructions that build upon another. The easiest way to create a run is to [launch a protocol](//developers.transcriptic.com/v1.0/docs/list-all-protocols), but you can also create them directly. The `run` object that must be submitted in the POST body has the form: [block:code] { "codes": [ { "code": "{\n \"title\": \"My run title\",\n \"protocol\": {\n /* autoprotocol body with `ref` and `instruction` stanzas */\n },\n \"test_mode\": true /* or false */\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Submitting runs from packaged protocols via the API" } [/block] [block:callout] { "type": "danger", "title": "This feature is experimental" } [/block] It is also possible to programmatically launch packaged protocols such as those reloaded into your organization or from any other packages uploaded to your organization. Prior to `POST`ing to this end point a launch_request_id must be obtained from the protocols `launch` endpoint. The body of the request will look like below: [block:code] { "codes": [ { "code": "{\n \"title\": \"My run title\",\n \"launch_request_id\": \"lrxxxxxxx\", /* a genuine launch request id */\n \"test_mode\": true /* or false */\n}", "language": "json" } ] } [/block]

User Information

Try It Out

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