POST text

extract_mentions

1 credit

Extract @mentions from text

Endpoint

POST /api/v1/tools/text/extract_mentions

Body Parameters

text string required

Example

input Request

{
    "text": "Thanks @alice and @bob!"
}

output Response

{
    "count": 2,
    "matches": [
        "@alice",
        "@bob"
    ]
}

Response Format

HTTP/1.1 200 OK SUCCESS

{
  "success": true,
  "data": {
    "count": 2,
    "matches": [
        "@alice",
        "@bob"
    ]
},
  "meta": {
    "tool": "extract_mentions",
    "credits_consumed": 1
  }
}

HTTP/1.1 422 Unprocessable Entity ERROR

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid."
  }
}

Code Examples

Request Example

lightbulb Developer Tip

Credits are deducted before execution. If the upstream tool fails, credits are automatically refunded to your account.