webrobot-sdk-python

Install the webrobot SDK with pip from the GitHub repository, configure a webrobot.Configuration with your host and API key or JWT, then create a DefaultApi client. Call typed methods like get_all_projects() or execute_job(project_id, job_id) to interact with the API.

Use either an API key passed as X-API-Key in the Configuration api_key parameter, or a JWT bearer token via the access_token parameter. Never use both at once. Credentials can come from environment variables or be parsed from ~/.webrobot/config.cfg.

The Python SDK is a client for calling the WebRobot REST API from external applications. Python extensions run inside the ETL engine as Spark UDFs with a row-dict contract and cannot make SDK calls. Use the SDK for client-side integration only.

Catch webrobot.rest.ApiException for typed DefaultApi calls; it exposes status, body, headers, and reason attributes. For raw requests-based calls, catch requests.HTTPError after calling raise_for_status() to inspect the response status code and body.

Yes, use the requests library with the same X-API-Key header for partner-vertical or undocumented endpoints. A thin api_call helper can add path templating by substituting {placeholder} segments from the params dict before sending the request.

No, the /webrobot/api/catalog/stages endpoint is public and read-only. Adding auth headers is unnecessary and produces an identical response, so call it directly with requests and no credentials.