Skip to main content
POST
/
v1
/
creators
/
match
cURL
curl --request POST \
  --url https://api.influship.com/v1/creators/match \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "creators": [
    {
      "creator_id": "123e4567-e89b-12d3-a456-426614174000",
      "platform": "instagram",
      "username": "fitness_coach_jane"
    }
  ],
  "intent": {
    "query": "Looking for fitness influencers to promote our new protein bar",
    "context": "Target audience is health-conscious millennials"
  }
}
'
import Influship from 'influship';

const client = new Influship({
  apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
});

const response = await client.creators.match({
  creators: [{}, {}],
  intent: { query: 'Promote our new plant-based protein powder' },
});

console.log(response.data);
import os
from influship import Influship

client = Influship(
    api_key=os.environ.get("INFLUSHIP_API_KEY"),  # This is the default and can be omitted
)
response = client.creators.match(
    creators=[{}, {}],
    intent={
        "query": "Promote our new plant-based protein powder"
    },
)
print(response.data)
{
  "data": [
    {
      "creator": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "avatar_url": "<string>"
      },
      "input": {
        "creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform": "instagram",
        "username": "<string>"
      },
      "match": {
        "score": 0.85,
        "decision": "good",
        "reasons": [
          {
            "text": "Strong fit due to fitness content focus and engaged audience",
            "fact_id": "<string>",
            "source_post_id": "<string>"
          }
        ]
      }
    }
  ]
}
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "param": "query",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {}
  }
}
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "param": "query",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {}
  }
}
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "param": "query",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {}
  }
}
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "param": "query",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {}
  }
}
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "param": "query",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {}
  }
}
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "param": "query",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {}
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Score campaign fit request

Score campaign fit request

creators
object[]
required

Creators to evaluate

Required array length: 1 - 100 elements
intent
object
required

Campaign intent for creator matching

Response

Successful response

data
object[]
required