# behavioralsignals Documentation

> Our production-level ΑPI, oliver.behavioralsignals.com, offers a rich variety of emotional and behavioral metrics, allows both real-time and batch audio processing, and can readily support heavy-duty applications.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Register to Behavioral Signals API](https://behavioralsignals.readme.io/docs/getting-started.md): Find here info on how to register to Behavioral Signals' service API
- [Create a Project and API Token](https://behavioralsignals.readme.io/docs/create-a-project-and-api-token.md): This guide will help you create a Project to use the API
- [Behavioral Signals Python SDK](https://behavioralsignals.readme.io/docs/behavioral-signals-python-sdk.md): Make integration easier using our SDK
- [Start a new process](https://behavioralsignals.readme.io/docs/first-steps.md): First step is to submit an audio file for processing
- [Check the progress of a process](https://behavioralsignals.readme.io/docs/check-the-processing-progress.md): Poll for process status and get metadata
- [Get results after completion](https://behavioralsignals.readme.io/docs/get-results-after-completion.md): You can get results for various levels of processing
- [Start a streaming session](https://behavioralsignals.readme.io/docs/start-a-streaming-session.md): Get real-time predictions using the streaming endpoint
- [Submit audio file](https://behavioralsignals.readme.io/docs/submit-audio-file.md): Submit a new process using audio file upload
- [Submit an S3 signed url](https://behavioralsignals.readme.io/docs/submit-an-s3-signed-url.md): Process a file by providing the S3 signed url
- [Retrieve results](https://behavioralsignals.readme.io/docs/retrieve-results.md): Results at the file/call level
- [Embeddings](https://behavioralsignals.readme.io/docs/embeddings.md)
- [Functionality and definitions](https://behavioralsignals.readme.io/docs/definitions.md): Basic terminology
- [Streaming using the Python SDK](https://behavioralsignals.readme.io/docs/streaming-using-python-sdk.md): Streaming using the SDK
- [Streaming using a bare gRPC client](https://behavioralsignals.readme.io/docs/streaming-using-a-bare-grpc-client.md): Generate a gRPC client from scratch
- [Proto file](https://behavioralsignals.readme.io/docs/proto-file.md): The api.proto file that defines the gRPC service for streaming (behavioral/deepfakes)
- [Definition of deepfakes](https://behavioralsignals.readme.io/docs/definition-of-audio-deepfakes.md): Basic terminology of audio and video deepfakes
- [Interactive demo](https://behavioralsignals.readme.io/docs/interactive-demo.md): Easy testing of our deepfake detection platform
- [Submit file](https://behavioralsignals.readme.io/docs/submit-a-file-for-processing.md): Use the batch API to submit recordings or videos for deepfake detection analysis
- [Submit an S3 signed url](https://behavioralsignals.readme.io/docs/submit-an-s3-signed-url-1.md): Process a file by providing the S3 signed url
- [Retrieve results](https://behavioralsignals.readme.io/docs/retrieve-results-1.md): Results at the file/call level
- [Embeddings](https://behavioralsignals.readme.io/docs/embeddings-1.md)
- [Real-time deepfake detection](https://behavioralsignals.readme.io/docs/real-time-deepfake-detection.md): Use the streaming API for real-time results
- [(Experimental) Generator Detection](https://behavioralsignals.readme.io/docs/generator-detection.md): Learn how to use the experimental generator detection feature to identify which model was likely used to generate deepfake audio utterances.
- [Get client information](https://behavioralsignals.readme.io/docs/get-client-information.md): You can get your client information
- [Get a status update of the service](https://behavioralsignals.readme.io/docs/get-a-status-update-of-the-service.md): You can use this API to get status information about the service

## API Reference
- [/auth](https://behavioralsignals.readme.io/reference/clientauth.md): Authenticates a client
- [/clients](https://behavioralsignals.readme.io/reference/createclient.md): Create a new client
- [/clients](https://behavioralsignals.readme.io/reference/getclients.md): Get clients list
- [/clients/{cid}](https://behavioralsignals.readme.io/reference/infoclient.md): Return a client's details
- [/clients/{cid}](https://behavioralsignals.readme.io/reference/deleteclient.md): Delete a client with given cid
- [/status](https://behavioralsignals.readme.io/reference/servicestatus.md): Return status of the service
- [/tokens](https://behavioralsignals.readme.io/reference/modifytoken.md): Inserts/Updates a token
- [/clients/{cid}/processes](https://behavioralsignals.readme.io/reference/getallprocesses.md): Returns all processes of a client
- [/clients/{cid}/processes/{pid}](https://behavioralsignals.readme.io/reference/getprocessinfo.md): Returns process info for pid by client request
- [/clients/{cid}/processes/audio](https://behavioralsignals.readme.io/reference/sendprocessaudio.md): Sends a new request with audio file upload
- [/clients/{cid}/processes/s3-presigned-url](https://behavioralsignals.readme.io/reference/sendprocesspresigneds3.md): Sends a new request with audio file from a signed S3 URL
- [/clients/{cid}/processes/{pid}/results](https://behavioralsignals.readme.io/reference/getprocessresults.md): Returns process results in JSON for pid by client request
- [/detection/clients/{cid}/processes](https://behavioralsignals.readme.io/reference/getalldetectionprocesses.md): Returns all deepfake detection processes of a client
- [/detection/clients/{cid}/processes/{pid}](https://behavioralsignals.readme.io/reference/getdetectionprocessinfo.md): Returns process info of deepfake detection for pid by client request
- [/detection/clients/{cid}/processes/audio](https://behavioralsignals.readme.io/reference/senddetectionaudio.md): Sends a new request with audio file upload to deepfake detection
- [/detection/clients/{cid}/processes/s3-presigned-url](https://behavioralsignals.readme.io/reference/senddetectionpresigneds3.md): Sends a new request with audio file from a signed S3 URL for deepfake detection
- [/detection/clients/{cid}/processes/{pid}/results](https://behavioralsignals.readme.io/reference/getdetectionresults.md): Returns deepfake detection results in JSON for pid by client request
- [/detection/clients/{cid}/processes/video](https://behavioralsignals.readme.io/reference/getallvideodetectionprocesses.md): Returns all video deepfake detection processes of a client
- [/detection/clients/{cid}/processes/video](https://behavioralsignals.readme.io/reference/senddetectionvideo.md): Sends a new request with video file upload for video deepfake detection
- [/detection/clients/{cid}/processes/video/{pid}](https://behavioralsignals.readme.io/reference/getvideodetectionprocessinfo.md): Returns process info of video deepfake detection for pid by client request
- [/detection/clients/{cid}/processes/s3-presigned-video-url](https://behavioralsignals.readme.io/reference/senddetectionpresignedvideos3.md): Sends a new request with video file from a signed S3 URL for video deepfake detection
- [/detection/clients/{cid}/processes/video/{pid}/results](https://behavioralsignals.readme.io/reference/getvideodetectionresults.md): Returns video deepfake detection results in JSON for pid by client request

## Changelog
- [Behavioral Signals API scheduled update v1.6.15](https://behavioralsignals.readme.io/changelog/oliver-api-scheduled-update-v1615.md)
- [Behavioral Signals API scheduled update v1.6.2](https://behavioralsignals.readme.io/changelog/oliver-api-scheduled-update-v342.md)
- [Welcome to Behavioral Signals API](https://behavioralsignals.readme.io/changelog/welcome-to-oliver.md)