Get a library script
/library/{author}/{slug}Describes one script from the library: what it is, its settings and outputs, and the scripts it reads, at its latest saved version or at the version in slug@N. Call it before you run a script you did not write, to see which settings it takes.
Scope | Heavy call | Long poll | CLI |
|---|---|---|---|
| No | No |
|
Guidance
authoris a username,chartnautfor a built-in, ormefor your own. The path is the item'sreffrom Search the library, withme/in front of your own slugs.Someone else's script is found when it is public, or unlisted and you have added it to your library in the app. That is the same rule Create a run uses, so anything this call describes, you can run. Their studies are never found.
The source never comes back: no
filesand no code, whatever the script's author allows in the app. You can still run it by its ref.slug@Ndescribes versionN.versionin the answer is the version described, anddependenciesare that version's.One of your studies can share a slug with one of your indicators or definitions. Then this call answers
409 conflictuntil you addkind.
Path parameters
Name | Type | Description |
|---|---|---|
| string | A username, |
| string | The script's slug, or |
Query parameters
Name | Type | Required | Default | Description |
|---|---|---|---|---|
| string | No | None |
|
Response
200 with a Library script in its full form: always with interface, version and dependencies.
Status codes
Status | Code | Meaning |
|---|---|---|
| - | The script at the version asked for |
|
| The slug or version in the path is not valid, or |
|
| No script by that author and slug that you can see, or it has no version |
|
| A study shares the slug. Add |