# SoilOptix Analyses - Billable API

**Canonical:** https://apis.io/apis/soiloptix/soiloptix-analyses-billable-api/  
**Provider:** SoilOptix — https://apis.io/providers/soiloptix/  
**Base URL:** https://api.soiloptix.com  
**Documentation:** https://api.soiloptix.com/

SoilOptix Analyses - Billable API is one of 14 APIs that [SoilOptix](https://apis.io/providers/soiloptix/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Analyses - Billable. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

Create a new analysis for a field, make changes to an existing Analysis, or view Messages and Files related to an Analysis. To submit a new Analysis, you would generally follow these steps: - **Create Analysis**: Create an analysis for an existing Field (usually a Resample) or create the Field and provide the FieldId when creating the Analysis. You will need to specify which Contract this Analysis will be billed to if you have access to more than one Contract. - **Upload Files**: Provide the required files including Survey, Activities (in Survey subfolder), Boundary, and available Labs. If this is a Resample then Survey and Activities may not be required. You may also submit a Boundary as WKT or use the Boundary Editor on the Portal to make any required changes. Labs do not need to be provided prior to submitting, however you must submit the Analysis again after adding additional or delayed Labs. - **Select Packages**: Select which Packages are to be included with this Analysis prior to submitting your Analysis for the first time. The available Packages are determined by your Contract. (**Tip:** You can include Packages when making a GET request for your Analysis details to see the selected and available Packages. Default Packages are selected when an Analysis is created). - **Submit**: You must submit an Analysis for processing before work will begin. You may submit an Analysis prior to providing all relevant Labs to recieve partial results as quickly as possible, however you must use the Submit action again after providing additional Labs or other data. At any time, you can use Messages to reach out to our team regarding this Analysis and view the responses. (**Tip:** When marking a message as read, it will be marked as read for all Users with Billable access to this Analysis. You can also discover all of your unread Messages using Notifications).

## Operations (13)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v4/analyses/` | Create a new analysis |
| PATCH | `/api/v4/analyses/{analysis_id}` | Update an existing analysis |
| GET | `/api/v4/analyses/{analysis_id}/files` | Get a list of all uploaded files to provided analysis |
| GET | `/api/v4/analyses/{analysis_id}/files/{subfolder}` | Get a list of uploaded files to provided analysis by folder |
| GET | `/api/v4/analyses/{analysis_id}/files/{subfolder}/{filename}` | Download a file from an analysis |
| DELETE | `/api/v4/analyses/{analysis_id}/files/{subfolder}/{filename}` | Delete a file from an analysis |
| POST | `/api/v4/analyses/{analysis_id}/boundary` | Save Boundary to Analysis in WKT format |
| PATCH | `/api/v4/analyses/{analysis_id}/packages` | Select packages for an analysis or provide an empty list to deselect all |
| PUT | `/api/v4/analyses/{analysis_id}/submit` | Submit an analysis |
| POST | `/api/v4/analyses/{analysis_id}/files/upload/` | Upload a file to an analysis |
| GET | `/api/v4/analyses/{analysis_id}/messages/` | Get all messages for a given analysis |
| POST | `/api/v4/analyses/{analysis_id}/messages/` | Create a new message for a given analysis |
| PUT | `/api/v4/analyses/{analysis_id}/messages/{message_id}/read` | Mark a message as read for a given analysis |

## Machine-readable artifacts (9)

- **OpenAPI** — https://artifacts.apis.io/soiloptix/openapi/soiloptix-analyses-billable-api-openapi.yml
- **Documentation** — https://api.soiloptix.com/
- **JSONSchema** — https://artifacts.apis.io/soiloptix/json-schema/soiloptix-business-schema.json
- **JSONSchema** — https://artifacts.apis.io/soiloptix/json-schema/soiloptix-analysis-schema.json
- **JSONSchema** — https://artifacts.apis.io/soiloptix/json-schema/soiloptix-business-update-schema.json
- **JSONSchema** — https://artifacts.apis.io/soiloptix/json-schema/soiloptix-business-create-schema.json
- **JSONSchema** — https://artifacts.apis.io/soiloptix/json-schema/soiloptix-field-schema.json
- **JSONSchema** — https://artifacts.apis.io/soiloptix/json-schema/soiloptix-farm-schema.json
- **APIsJSON** — https://artifacts.apis.io/soiloptix/apis.yml

## Other SoilOptix APIs (12)

- [SoilOptix Analyses - Read API](https://apis.io/apis/soiloptix/soiloptix-analyses-read-api/)
- [SoilOptix Authentication API](https://apis.io/apis/soiloptix/soiloptix-authentication-api/)
- [SoilOptix Businesses API](https://apis.io/apis/soiloptix/soiloptix-businesses-api/)
- [SoilOptix Countries API](https://apis.io/apis/soiloptix/soiloptix-countries-api/)
- [SoilOptix Farms API](https://apis.io/apis/soiloptix/soiloptix-farms-api/)
- [SoilOptix Fields API](https://apis.io/apis/soiloptix/soiloptix-fields-api/)
- [SoilOptix My Account API](https://apis.io/apis/soiloptix/soiloptix-my-account-api/)
- [SoilOptix v3 - Boundaries API](https://apis.io/apis/soiloptix/soiloptix-v3-boundaries-api/)
- [SoilOptix v3 - Customers API](https://apis.io/apis/soiloptix/soiloptix-v3-customers-api/)
- [SoilOptix v3 - Farms API](https://apis.io/apis/soiloptix/soiloptix-v3-farms-api/)
- [SoilOptix v3 - Fields API](https://apis.io/apis/soiloptix/soiloptix-v3-fields-api/)
- [SoilOptix v3 - Identity API](https://apis.io/apis/soiloptix/soiloptix-v3-identity-api/)

## Tags

Analyses - Billable

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/soiloptix/soiloptix-analyses-billable-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/soiloptix/.