Api¶
- class Api[source]¶
Bases:
object
An API connection to the server with which you can communicate with your teams, workspaces and projects.
Api
object is immutable.- Parameters
- server_address : str
Address of the server.
- token : str
Unique secret token associated with your agent.
- retry_count : int, optional
The number of attempts to connect to the server.
- retry_sleep_sec : int, optional
The number of seconds to delay between attempts to connect to the server.
- external_logger : logger, optional
Logger class object.
- ignore_task_id : bool, optional
- Raises
ValueError
, if token is None or it length != 128- Usage example
import os from dotenv import load_dotenv import supervisely as sly # Load secrets and create API object from .env file (recommended) # Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication if sly.is_development(): load_dotenv(os.path.expanduser("~/supervisely.env")) api = sly.Api.from_env() # Pass values into the API constructor (optional, not recommended) # api = sly.Api(server_address="https://app.supervise.ly", token="4r47N...xaTatb")
Methods
Add given key and value to additional_fields dictionary.
Add given key and value to headers dictionary.
Initialize API use environment variables.
Performs GET request to server with given parameters.
normalize_server_address
- rtype
Processes error from response.
pop_header
- rtype
Performs POST request to server with given parameters.
- add_header(key, value)[source]¶
Add given key and value to headers dictionary.
- Parameters
- Raises
RuntimeError
, if key is already set- Returns
None
- Return type
NoneType
-
classmethod from_env(retry_count=
10
, ignore_task_id=False
, env_file='~/supervisely.env'
)[source]¶ Initialize API use environment variables.
- Parameters
- Returns
Api object
- Return type
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() # alternatively you can store SERVER_ADDRESS and API_TOKEN # in "~/supervisely.env" .env file # Learn more here: https://developer.supervise.ly/app-development/basics/add-private-app#create-.env-file-supervisely.env-with-the-following-content-learn-more-here api = sly.Api.from_env()
-
get(method, params, retries=
None
, stream=False
, use_public_api=True
)[source]¶ Performs GET request to server with given parameters.
- Parameters
- Returns
Response object
- Return type
Response
-
static parse_error(response, default_error=
'Error'
, default_message='please, contact administrator'
)[source]¶ Processes error from response.