---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CCCIF Media Resource API

# CCCIF Media Resource API {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read

The Custom Chat Chatbot Interoperability Framework (CCCIF) Media Resource API provides endpoints that enable a primary bot to upload attachments to
the associated ServiceNow instance.
Call this API in your primary bot to upload private attachments from a user that is having a
conversation through Virtual Agent (VA). You must then send the
mediaUrl parameter that is returned by this API to the VA API.

If the attachment is public, you can just send the attachment URL in the request body of your
[Virtual Agent Bot Integration](https://servicenow-prod.fluidtopics.net/M~85qUGLcpbl4sDIi3zBIw#bot-api "The Virtual Agent Bot Integration API provides endpoints that allow users to integrate any chat interface or a bot ecosystem with the ServiceNow Virtual Agent and/or Live Agent.") call.

To access this API, the Conversational Custom Chat Integration (com.glide.cs.custom.adapter)
plugin must be activated. In addition, the attachment system properties must be configured.

For additional information on the capabilities of the Virtual Agent API, see
[Virtual Agent API](https://www.servicenow.com/docs/access?context=virtual-agent-api&version=xanadu&pubname=xanadu-conversational-interfaces&ft:locale=en-US).

## CCCIF - POST /cccif/media/upload {#ariaid-title2}

Uploads a private attachment to the called ServiceNow instance
which stores the attachment in the Attachments \[sys_attachment\] table.
Call this method in your primary bot to upload private attachments from a user that is
having a conversation through Virtual Agent (VA). You must then send the
mediaUrl parameter that is returned by this method to the VA API using
the [Virtual Agent Bot Integration API](https://servicenow-prod.fluidtopics.net/M~85qUGLcpbl4sDIi3zBIw#bot-api "The Virtual Agent Bot Integration API provides endpoints that allow users to integrate any chat interface or a bot ecosystem with the ServiceNow Virtual Agent and/or Live Agent.").

### URL format

Versioned URL:
/api/now/{api_version}/cccif/media/upload

Default URL:
/api/now/cccif/media/upload

### Supported request parameters

{#cccif-media-upload__entry__2}{#cccif-media-upload__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 1. Path parameters]

{#cccif-media-upload__entry__6}

| Name | Description |
|-|-|
| None |   |
[Table 2. Query parameters]

{#cccif-media-upload__entry__10}

| Name | Description |
|-|-|
| file | Required. Path of the file to upload. Data type: String, such as @File path \<file_path\> |
| provider_application_id | Sys_id of the sys_cs_provider_application interacting with the VA bot. Default: Sys_id of the VA Bot to Bot Provider Application |
| user_id | Required. Unique user identifier of the user interacting with the VA bot. This can be any string that is unique for each user. Data type: String |
[Table 3. Request body parameters]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cccif-media-upload__entry__18}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: multipart/form-data. |
[Table 4. Request headers]

{#cccif-media-upload__entry__22}

| Header | Description |
|-|-|
| Content-Type | Data format of the response body. Only supports application/json. |
[Table 5. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cccif-media-upload__entry__26}{#cccif-media-upload__entry-400-status-code}{#cccif-media-upload__entry-401-status-code}{#cccif-media-upload__entry-404-status-code}{#cccif-media-upload__entry-500-status-code}

| Status code | Description |
|-|-|
| 201 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 404 | Not found. The requested item wasn't found. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 6. Status codes]

### Response body parameters (JSON)

{#cccif-media-upload__entry__38}

| Name | Description |
|-|-|
| attachmentId | Sys_id of the attachment that was stored. Data type: String |
| error | Description of any error detected while processing the request. Data type: Object "error": { "detail": "String", "message": "String" } |
| error.detail | Details about the error that was encountered. Data type: String |
| error.message | Message describing the error that was thrown. Data type: String |
| mediaUrl | Attachment URL to send to the primary bot to access the attachment. The primary bot must send this URL in the message.attachment.url parameter of the request body of the POST /sn_va_as_service/bot/integration endpoint. Data type: String |
| name | File name of the attachment. Data type: String |
| state | State of the attachment in the Attachment table. Possible values: * available * conditionally available * not available * pending {#cccif-media-upload__ul_mxv_yjp_trb} Data type: String |
[ ]

### cURL request

This example shows how to upload a .png file attachment.

    curl --location --request POST 'https://instance.servicenow.com/api/now/v1/cccif/media/upload' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --header 'Content-Type:multipart/form-data' \
    --form 'user_id="lincoln"' \
    --form 'file=@"/Users/Desktop/Screenshot 2021-10-25 at 5.08.14 PM.png"'

Response:

    Response :{
      "result": {
        "mediaUrl": "https://instance.servicenow.com/api/now/v1/cs/media/vGfewkfAv0VBo2RxmlTM448L789Pp6rqLFLUNYQxZsUUFrsgMA8aW9W0zWx1a5fG",
        "name": "Screenshot 2021-10-25 at 5.08.14 PM.png",
        "state": "pending",
        "attachmentId": "299c648887b73c1022b6a6cd0ebb3534"
      }