# Spicepods API

A Spicepod is a package (a zip file) of data and AI configuration used by a Spice application.

A Spicepod manifest is a YAML file with Spice application configuration.

### APIs

**Upload a Spicepod**

## Upload a Spicepod

<mark style="color:green;">`POST`</mark> `https://data.spiceai.io/v0.1/orgs/{org_name}/apps/{app_id}/spicepods`

#### Path Parameters

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| org\_name<mark style="color:red;">\*</mark> | String |             |
| app\_id<mark style="color:red;">\*</mark>   | Number |             |

#### Request Body

| Name                                      | Type   | Description                                     |
| ----------------------------------------- | ------ | ----------------------------------------------- |
| Content<mark style="color:red;">\*</mark> | String | Spicepod file content an an octect stream (zip) |

{% tabs %}
{% tab title="201: Created " %}

{% endtab %}
{% endtabs %}

#### List Spicepods

## List all Spicepods

<mark style="color:blue;">`GET`</mark> `https://data.spiceai.io/v0.1/orgs/{org_name}/apps/{app_id}/spicepods`

#### Path Parameters

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| org\_name<mark style="color:red;">\*</mark> | String |             |
| app\_id<mark style="color:red;">\*</mark>   | Number |             |

{% tabs %}
{% tab title="200: OK List of spicepods " %}

{% endtab %}
{% endtabs %}

**Get a Spicepod**

## Get a Spicepod by name

<mark style="color:blue;">`GET`</mark> `https://data.spiceai.io/v0.1/orgs/{org_name}/apps/{app_id}/spicepods/{name}`

#### Path Parameters

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| org\_name<mark style="color:red;">\*</mark> | String |             |
| app\_id<mark style="color:red;">\*</mark>   | Number |             |
| name<mark style="color:red;">\*</mark>      | String |             |

{% tabs %}
{% tab title="200: OK Content of the spicepod " %}

{% endtab %}
{% endtabs %}

**Delete a Spicepod**

## Delete a Spicepod by name

<mark style="color:red;">`DELETE`</mark> `https://data.spiceai.io/v0.1/orgs/{org_name}/apps/{app_id}/spicepods/{name}`

#### Path Parameters

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| org\_name<mark style="color:red;">\*</mark> | String |             |
| app\_id<mark style="color:red;">\*</mark>   | Number |             |
| name                                        | String |             |

{% tabs %}
{% tab title="204: No Content " %}

{% endtab %}
{% endtabs %}

### Limitations

* Maximum size of a Spicepod file is 1MB.