Skip to main content
POST
/
api
/
connectors
/
files
cURL
curl --request POST \
  --url https://api.recoupable.com/api/connectors/files \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "toolSlug": "<string>"
}
'
{
  "success": true,
  "name": "<string>",
  "mimetype": "<string>",
  "s3key": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Body

application/json

The image URL to stage and the action it will be attached to.

​
url
string<uri>
required

Publicly reachable URL of the image to stage. Fetched server-side and uploaded to Connector storage. Required.

​
toolSlug
string
required

The action slug the image will be attached to, UPPERCASE_SNAKE_CASE (e.g. LINKEDIN_CREATE_LINKED_IN_POST). Scopes the upload to that tool/toolkit. Required.

Response

Image staged. Returns the Connector file descriptor to embed in the action's file_uploadable array.

​
success
boolean
required
​
name
string
required

Stored filename.

​
mimetype
string
required

Detected MIME type of the stored file.

​
s3key
string
required

Connector storage key. Pass this together with name and mimetype in the action's file_uploadable array.