Configuration types
AvalaConfig
Configuration options for initializing the Avala client.API key for authentication. Can also be set via
AVALA_API_KEY environment variable.Base URL for the Avala API. Defaults to
https://api.avala.ai.Request timeout in milliseconds. Defaults to 60000 (60 seconds).
Resource types
Dataset
Represents a dataset in Avala.Unique identifier for the dataset.
Display name of the dataset.
URL-friendly identifier for the dataset.
Number of items in the dataset.
Type of data stored in the dataset (e.g., “image”, “video”, “pointcloud”).
ISO 8601 timestamp of when the dataset was created.
ISO 8601 timestamp of when the dataset was last updated.
Project
Represents an annotation project.Unique identifier for the project.
Display name of the project.
Current status of the project.
ISO 8601 timestamp of when the project was created.
ISO 8601 timestamp of when the project was last updated.
Export
Represents a dataset export.Unique identifier for the export.
Current status of the export (e.g., “pending”, “processing”, “completed”, “failed”).
URL to download the export once completed.
ISO 8601 timestamp of when the export was created.
ISO 8601 timestamp of when the export was last updated.
Task
Represents an annotation task.Unique identifier for the task.
Type of annotation task (e.g., “bounding_box”, “segmentation”).
Display name of the task.
Current status of the task.
UID of the project this task belongs to.
ISO 8601 timestamp of when the task was created.
ISO 8601 timestamp of when the task was last updated.
StorageConfig
Represents a storage configuration for cloud storage integration.Unique identifier for the storage configuration.
Display name of the storage configuration.
Storage provider type (e.g., “aws_s3”, “google_cloud_storage”).
AWS S3 bucket name (for S3 provider).
AWS S3 bucket region (for S3 provider).
AWS S3 bucket prefix/path (for S3 provider).
Whether S3 transfer acceleration is enabled.
Google Cloud Storage bucket name (for GCS provider).
Google Cloud Storage bucket prefix/path (for GCS provider).
Whether the storage configuration has been verified.
ISO 8601 timestamp of when the configuration was last verified.
ISO 8601 timestamp of when the configuration was created.
ISO 8601 timestamp of when the configuration was last updated.
Dataset items and sequences
DatasetItem
Represents a single item in a dataset.Numeric ID of the dataset item.
Unique identifier for the dataset item.
Unique key for the item within the dataset.
UID of the dataset this item belongs to.
URL to access the item’s data.
GPU-optimized texture URL for 3D data.
Array of thumbnail URLs for the item.
Thumbnail URL for video items.
Custom metadata associated with the item.
Export-specific data for the item.
Annotations associated with the item.
Crop data for the item.
Array of related dataset items.
UID of the related sequence, if this item is part of a sequence.
ISO 8601 timestamp of when the item was created.
ISO 8601 timestamp of when the item was last updated.
DatasetSequence
Represents a sequence of related dataset items (e.g., video frames, sensor data over time).Unique identifier for the sequence.
Unique key for the sequence within the dataset.
Custom UUID for the sequence.
Current status of the sequence.
URL of the featured/thumbnail image for the sequence.
Total number of frames in the sequence.
Array of view configurations for the sequence.
Crop data for the sequence.
Array of predefined labels for the sequence.
Array of frames in the sequence.
Metrics associated with the sequence.
UID of the dataset this sequence belongs to.
Whether LiDAR calibration is allowed for this sequence.
Whether LiDAR calibration is enabled.
Whether camera calibration is enabled.
SliceItem
Represents an item in a slice (filtered view of a dataset).Numeric ID of the slice item.
Unique identifier for the slice item.
Unique key for the item.
UID of the source dataset.
URL to access the item’s data.
GPU-optimized texture URL for 3D data.
Array of thumbnail URLs for the item.
Thumbnail URL for video items.
Custom metadata associated with the item.
Export-specific data for the item.
Annotations associated with the item.
Crop data for the item.
Array of related dataset items.
UID of the related sequence.
ISO 8601 timestamp of when the item was created.
ISO 8601 timestamp of when the item was last updated.
Agent and automation types
Agent
Represents an AI agent that can be triggered by events.Unique identifier for the agent.
Display name of the agent.
Description of what the agent does.
Array of event types that trigger this agent.
URL to call when the agent is triggered.
Whether the agent is currently active.
UID of the project this agent is associated with.
Array of task types this agent can handle.
ISO 8601 timestamp of when the agent was created.
ISO 8601 timestamp of when the agent was last updated.
AgentExecution
Represents a single execution of an agent.Unique identifier for the execution.
UID of the agent registration.
Type of event that triggered this execution.
UID of the task this execution is associated with.
Result of the execution.
Current status of the execution (e.g., “pending”, “running”, “completed”, “failed”).
Action taken by the agent.
Payload of the event that triggered the execution.
Response payload from the agent.
Error message if the execution failed.
ISO 8601 timestamp of when the execution started.
ISO 8601 timestamp of when the execution completed.
ISO 8601 timestamp of when the execution was created.
ISO 8601 timestamp of when the execution was last updated.
InferenceProvider
Represents an AI model provider for inference.Unique identifier for the inference provider.
Display name of the provider.
Description of the provider.
Type of provider (e.g., “openai”, “anthropic”, “custom”).
Configuration for the provider.
Whether the provider is currently active.
UID of the project this provider is associated with.
ISO 8601 timestamp of when the provider was last tested.
Whether the last test was successful.
ISO 8601 timestamp of when the provider was created.
ISO 8601 timestamp of when the provider was last updated.
AutoLabelJob
Represents an automatic labeling job.Unique identifier for the auto-label job.
Current status of the job (e.g., “pending”, “running”, “completed”, “failed”).
Type of model used for auto-labeling.
Minimum confidence threshold for applying labels.
Array of labels to apply.
Whether this is a dry run (no actual labels applied).
Total number of items to process.
Number of items processed so far.
Number of items successfully labeled.
Number of items that failed to label.
Number of items skipped.
Progress percentage (0-100).
Error message if the job failed.
Summary of the job results.
ISO 8601 timestamp of when the job started.
ISO 8601 timestamp of when the job completed.
ISO 8601 timestamp of when the job was created.
Quality and consensus types
QualityTarget
Represents a quality metric target.Unique identifier for the quality target.
Display name of the target.
Metric to measure (e.g., “iou”, “accuracy”).
Comparison operator (e.g., “gt”, “lt”, “eq”).
Threshold value for the metric.
Severity level if the target is breached (e.g., “low”, “medium”, “high”).
Whether the target is currently active.
Whether to send webhook notifications on breach.
Array of email addresses to notify on breach.
ISO 8601 timestamp of when the target was last evaluated.
Last measured value of the metric.
Whether the target is currently breached.
Number of times the target has been breached.
ISO 8601 timestamp of when the target was last breached.
ISO 8601 timestamp of when the target was created.
ISO 8601 timestamp of when the target was last updated.
QualityTargetEvaluation
Represents the evaluation of a quality target.Unique identifier for the evaluation.
Name of the quality target.
Metric being measured.
Threshold value for the metric.
Comparison operator used.
Current value of the metric.
Whether the target is breached.
Severity level of the breach.
ConsensusConfig
Configuration for consensus scoring.Unique identifier for the consensus configuration.
Intersection over Union (IoU) threshold for agreement.
Minimum agreement ratio (0-1) required for consensus.
Minimum number of annotations required.
ISO 8601 timestamp of when the configuration was created.
ISO 8601 timestamp of when the configuration was last updated.
ConsensusScore
Represents a consensus score for an annotated item.Unique identifier for the consensus score.
UID of the dataset item.
Name of the task.
Type of score (e.g., “iou”, “exact_match”).
Consensus score value (typically 0-1).
Number of annotators whose annotations were considered.
Additional details about the consensus calculation.
ISO 8601 timestamp of when the score was created.
ConsensusSummary
Summary statistics for consensus scores.Mean consensus score across all items.
Median consensus score across all items.
Minimum consensus score.
Maximum consensus score.
Total number of items scored.
Number of items that meet the consensus threshold.
Distribution of scores across ranges.
Breakdown of scores by task name.
ConsensusComputeResult
Result of a consensus computation operation.Status of the computation (e.g., “success”, “failed”).
Message describing the result.
Annotation issues
AnnotationIssue
Represents a reported issue with an annotation.Unique identifier for the issue.
UID of the dataset item with the issue.
UID of the sequence with the issue.
Project information.
Information about who reported the issue.
Priority level of the issue.
Severity level of the issue.
Description of the issue.
Current status of the issue (e.g., “open”, “resolved”, “closed”).
Tool used for the annotation.
Type of problem identified.
The incorrect class label, if applicable.
The correct class label, if applicable.
Whether the item should be re-annotated.
Whether the annotation should be deleted.
Frames affected by the issue (for video/sequences).
Coordinates of the issue location.
Query parameters for navigating to the issue.
ISO 8601 timestamp of when the issue was created.
ISO 8601 timestamp of when the issue was closed.
UID of the annotation object with the issue.
AnnotationIssueProject
Project UID.
Project name.
AnnotationIssueReporter
Username of the reporter.
Profile picture URL of the reporter.
Full name of the reporter.
Type of reporter (e.g., “human”, “agent”).
Whether the reporter is a staff member.
AnnotationIssueTool
Tool UID.
Tool name.
Whether this is the default tool.
AnnotationIssueProblem
Problem UID.
Problem title.
AnnotationIssueMetrics
Metrics for annotation issues.Count of issues by status.
Count of issues by priority.
Count of issues by severity.
Mean time to close issues (in seconds) for all reporters.
Mean time to close issues (in seconds) for customer reporters.
Mean age of unresolved issues (in seconds) for all reporters.
Mean age of unresolved issues (in seconds) for customer reporters.
Count of issues by problem type.
AnnotationIssueToolDetail
Detailed information about an annotation issue tool.Tool UID.
Tool name.
Type of dataset this tool is for.
Whether this is the default tool.
Array of problems that can be reported with this tool.
Fleet management types
FleetDevice
Represents a device in a fleet.Unique identifier for the device.
Display name of the device.
Type of device (e.g., “sensor”, “camera”, “lidar”).
Current status of the device (e.g., “online”, “offline”, “error”).
Array of tags for organizing devices.
Current firmware version.
Additional metadata about the device.
ISO 8601 timestamp of when the device was last seen.
Authentication token for the device.
ISO 8601 timestamp of when the device was created.
ISO 8601 timestamp of when the device was last updated.
FleetRecording
Represents a recording from a fleet device.Unique identifier for the recording.
UID of the device that made the recording.
Current status of the recording (e.g., “recording”, “processing”, “completed”).
Duration of the recording in seconds.
Size of the recording in bytes.
Number of topics/channels in the recording.
Array of tags for organizing recordings.
Array of topics/channels included in the recording.
ISO 8601 timestamp of when the recording started.
ISO 8601 timestamp of when the recording ended.
ISO 8601 timestamp of when the recording was created.
ISO 8601 timestamp of when the recording was last updated.
FleetEvent
Represents an event that occurred on a fleet device or recording.Unique identifier for the event.
UID of the recording where the event occurred.
UID of the device where the event occurred.
Type of event (e.g., “error”, “warning”, “info”).
Label or category for the event.
Description of the event.
ISO 8601 timestamp of when the event occurred.
Duration of the event in milliseconds.
Array of tags for organizing events.
Additional metadata about the event.
Severity level of the event.
ISO 8601 timestamp of when the event was created.
ISO 8601 timestamp of when the event was last updated.
FleetRule
Represents an automation rule for fleet management.Unique identifier for the rule.
Display name of the rule.
Description of what the rule does.
Whether the rule is currently enabled.
Condition that triggers the rule.
Array of actions to take when the rule is triggered.
Scope where the rule applies (e.g., specific devices or recordings).
Number of times the rule has been triggered.
ISO 8601 timestamp of when the rule was last triggered.
ISO 8601 timestamp of when the rule was created.
ISO 8601 timestamp of when the rule was last updated.
FleetAlert
Represents an alert generated by a fleet rule.Unique identifier for the alert.
UID of the rule that generated the alert.
UID of the device related to the alert.
UID of the recording related to the alert.
Severity level of the alert.
Current status of the alert (e.g., “active”, “acknowledged”, “resolved”).
Alert message.
ISO 8601 timestamp of when the alert was triggered.
ISO 8601 timestamp of when the alert was acknowledged.
UID of the user who acknowledged the alert.
ISO 8601 timestamp of when the alert was resolved.
Note about how the alert was resolved.
ISO 8601 timestamp of when the alert was created.
ISO 8601 timestamp of when the alert was last updated.
FleetAlertChannel
Represents a channel for sending fleet alerts.Unique identifier for the alert channel.
Display name of the channel.
Type of channel (e.g., “email”, “webhook”, “slack”).
Configuration for the channel.
ISO 8601 timestamp of when the channel was created.
ISO 8601 timestamp of when the channel was last updated.
Webhook types
Webhook
Represents a webhook subscription.Unique identifier for the webhook.
URL where webhook events will be sent.
Array of event types this webhook subscribes to.
Whether the webhook is currently active.
ISO 8601 timestamp of when the webhook was created.
ISO 8601 timestamp of when the webhook was last updated.
WebhookDelivery
Represents a webhook delivery attempt.Unique identifier for the delivery.
UID of the webhook subscription.
Type of event that was delivered.
Payload that was sent.
HTTP status code of the response.
Response body from the webhook endpoint.
Number of delivery attempts.
ISO 8601 timestamp of when the next retry will occur.
Current status of the delivery (e.g., “pending”, “delivered”, “failed”).
ISO 8601 timestamp of when the delivery was created.
ISO 8601 timestamp of when the delivery was last updated.
Organization and team types
Organization
Represents an organization.Unique identifier for the organization.
Display name of the organization.
URL-friendly identifier for the organization.
Handle or username for the organization.
Description of the organization.
URL of the organization’s logo.
Organization’s website URL.
Industry the organization operates in.
Contact email for the organization.
Contact phone number for the organization.
Visibility setting (e.g., “private”, “public”).
Billing plan for the organization.
Whether the organization is verified.
Whether the organization is currently active.
Number of members in the organization.
Number of teams in the organization.
Number of datasets owned by the organization.
Number of projects owned by the organization.
Number of slices owned by the organization.
Current user’s role in the organization.
ISO 8601 timestamp of when the current user joined.
Array of email domains allowed for auto-joining.
ISO 8601 timestamp of when the organization was created.
ISO 8601 timestamp of when the organization was last updated.
OrganizationMember
Represents a member of an organization.UID of the user.
Username of the member.
Email address of the member.
Full name of the member.
Profile picture URL of the member.
Role of the member in the organization.
ISO 8601 timestamp of when the member joined.
Invitation
Represents an invitation to join an organization.Unique identifier for the invitation.
Name of the organization.
Slug of the organization.
Email address of the invitee.
Username of the person who sent the invitation.
Role the invitee will have.
Current status of the invitation (e.g., “pending”, “accepted”, “expired”).
ISO 8601 timestamp of when the invitation expires.
Whether the invitation is expired.
URL to accept the invitation.
Shareable link for the invitation.
ISO 8601 timestamp of when the invitation was created.
Team
Represents a team within an organization.Unique identifier for the team.
Display name of the team.
URL-friendly identifier for the team.
Description of the team.
Color code for the team (for UI purposes).
UID of the organization this team belongs to.
Name of the organization this team belongs to.
Slug of the organization this team belongs to.
Number of members in the team.
ISO 8601 timestamp of when the team was created.
ISO 8601 timestamp of when the team was last updated.
TeamMember
Represents a member of a team.UID of the user.
Username of the member.
Email address of the member.
Full name of the member.
Profile picture URL of the member.
Role of the member in the team.
ISO 8601 timestamp of when the member joined the team.
Slice types
Slice
Represents a slice (filtered view) of a dataset.Unique identifier for the slice.
Display name of the slice.
URL-friendly identifier for the slice.
Name of the owner.
Organization information.
Visibility setting (e.g., “private”, “public”).
Current status of the slice.
Number of items in the slice.
Array of sub-slices.
Source data configuration.
Array of URLs for featured items in the slice.
Authentication and signup types
SignupUser
User information returned after signup.Unique identifier for the user.
Username chosen by the user.
Email address of the user.
First name of the user.
Last name of the user.
Whether the user is in the waitlist.
SignupResponse
Response from the signup endpoint.Information about the newly created user.
API key for the new user.
Pagination types
CursorPage
Generic cursor-based pagination response.Array of items in the current page.
Cursor for the next page, or null if this is the last page.
Cursor for the previous page, or null if this is the first page.
Whether there are more items after the current page.
RawPageResponse
Raw API response shape from DRF cursor pagination.Array of raw result objects.
URL for the next page.
URL for the previous page.
Rate limiting types
RateLimitInfo
Information about rate limiting.Total rate limit.
Remaining requests before hitting the limit.
ISO 8601 timestamp of when the rate limit resets.