Functions by tool (platform, CLI, API)
Updated at January 12th, 2024
Here at Sama, we have three different methods for carrying out various functions.
Platform: The platform (which is what this documentation is for!) has a classic user interface and is approachable for people who aren't as familiar with developer tools. Depending on whether you have been assigned Annotator or Project Manager permissions, a different subset of tools will be available to you.
API: We recommend the API as the preferred method. It's more flexible and powerful than the platform and includes many time-saving shortcuts.
CLI: The functions that are available through the CLI are rapidly being expanded.
The table below maps everything that you can do and where — just click on a link to jump directly to the relevant documentation.
| I want to... | Platform (Annotator) |
Platform (Project Manager) |
API | CLI |
|---|---|---|---|---|
| List my projects | Go! | Go! | - | - |
| Start work | Go! | Go! | - | - |
| Stop work | Go! | Go! | - | - |
| Submit work | Go! | Go! | Go! | - |
| View a task's input schema | - | Go! | Go! | - |
| Upload tasks | - | Go! | Go! | Go! |
| Create tasks with model predictions (aka default answers) |
- | Go! | Go! | - |
| Create tasks with local assets | - | - | - | Go! |
| Prioritize tasks | - | Go! | Go! | - |
| View the status of tasks | - | Go! | Go! | Go! |
| Export tasks | - | Go! | Go! | - |
| Deliver tasks | - | - | Go! | Go! |
| Sample tasks | - | Go! | - | - |
| Reject tasks | - | Go! | Go! | - |
| Pause or activate a project | - | Go! | - | - |
| Manage inputs | - | Go! | - | - |
| Manage outputs | - | Go! | - | - |
| View a task's output schema | - | - | Go! | - |
| Manage workflows | - | Go! | - | - |
| Edit the workspace layout for each step | - | Go! | - | - |
| Upload assets to the S3 bucket | - | Go! | Go! | |
| Edit your profile | Go! | Go! | - | - |