Create a job | Labric | Documentation

curl -X POST https://platform.labric.co/api/v1/jobs \
     -H "Authorization: Bearer <api_key>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Tensile curve summary",
  "code": "# /// script\n# dependencies = [\"pandas\"]\n# ///\nimport os\nimport pandas as pd\nfrom labric import Labric\n\nclient = Labric()\ncurve = pd.read_csv(os.environ[\"LABRIC_FILE_PATH_0\"])\nsummary = {\n    \"specimen_id\": os.path.basename(os.environ[\"LABRIC_FILE_PATH_0\"]),\n    \"peak_load_n\": curve[\"load_n\"].max(),\n    \"elongation_at_break_pct\": curve[\"strain_pct\"].iloc[-1],\n}\nclient.tools.write(\n    target_type=\"table\",\n    target_name=\"tensile_summaries\",\n    data=[summary],\n    mode=\"create\",\n    job_execution_id=os.environ[\"LABRIC_JOB_EXECUTION_ID\"],\n)\n",
  "description": "Reduces each uploaded tensile test to its peak load and elongation at break."
}'

Create a job that runs a Python script on the platform.

The code becomes the job’s script; declare its dependencies inline in a PEP 723 # /// script block. The job then appears on the platform, where it can be run and its executions reviewed. To change an existing job’s name, description, or code, use update_job instead.

Requires an API key with the write scope.

Create a job that runs a Python script on the platform. The code becomes the job's script; declare its dependencies inline in a PEP 723 `# /// script` block. The job then appears on the platform, where it can be run and its executions reviewed. To change an existing job's name, description, or code, use update_job instead. Requires an API key with the `write` scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired1-200 characters

Name of the job. Unique within the organization.

codestringRequired

Python source of the script the job runs. Declare dependencies inline in a PEP 723 # /// script block.

descriptionstring or nullOptional

What the job does.

Response

idstringformat: "uuid"

Pass this as job_id to the job execution tools.

namestring

archivedboolean

descriptionstring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error