---
title: "Start GitHub lookup"
method: POST
path: "/v1/github-lookup/trigger"
tags: ["GitHub"]
---

# Start GitHub lookup

`POST /v1/github-lookup/trigger`

Use our AI agent to find GitHub profiles for a list of people using name and optional context like LinkedIn URL, work email, company, and job title.

<span>⚡ <strong>Rate limit:</strong> 30 requests per 1 minute</span>

<span>💰 <strong>Cost:</strong> 3 credits per person&nbsp;<span title="Pricing shown is default pricing. Actual pricing may vary.">ⓘ</span></span>

## Request body

- object
  - `apiKey` string, required — Your Fiber API key
  - `overallContext` string, required — A descriptor of what the people have in common (e.g. "Engineers at Fiber AI" or "YC founders 2021 batch"). Helps disambiguate people with similar names.
  - `people` union[], required — List of people to look up. Maximum 1000 people can be provided at a time.
    - union
      - object
        - `externalId` string, nullable — An external ID for joining results back to the original dataset.
        - `inputType` 'linkedinUrl', required
        - `linkedinUrl` string, required — LinkedIn URL, slug, or entity URN
      - object
        - `externalId` string, nullable — An external ID for joining results back to the original dataset.
        - `inputType` 'linkedinUserId', required
        - `linkedinUserId` string, required — LinkedIn numeric user ID
      - object
        - `externalId` string, nullable — An external ID for joining results back to the original dataset.
        - `inputType` 'manual', required
        - `fullName` string, required — The full name of the person whose GitHub profile you want to find.
        - `company` string, nullable
        - `jobTitle` string, nullable
        - `schoolName` string, nullable — School or university name
        - `workEmail` string, email, nullable
        - `linkedinUrl` string, uri, nullable

## Response `200`

Default Response

- object
  - `output` object, required
    - `githubAgentRunId` string, required — The ID of the GitHub lookup agent run. Provide this to the polling endpoint to get the actual results back.
  - `chargeInfo` union, required
    - object — Credits were charged immediately for this operation
      - `method` 'charged-now', required
      - `creditsCharged` number, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — Credits will be charged after the operation completes
      - `method` 'charging-later', required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — Credits that were charged for an asynchronous operation
      - `method` 'charged-for-async-process', required
      - `creditsCharged` number, required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — No credits were charged for this operation
      - `method` 'free', required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — Credits were refunded for this operation
      - `method` 'credits-refunded', required
      - `creditsRefunded` number, required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
  - `warnings` object[], nullable — Warnings about extraneous fields in request
    - `field` string, required — Full path to extraneous field (e.g., 'searchParams.ExtraField')
    - `message` string, required — Warning message
  - `advice` string[], nullable — Tips, recommendations, and suggestions for using this API effectively.

## Other responses

- `400` — Default Response
- `401` — Default Response
- `402` — Default Response
- `403` — Default Response
- `404` — Default Response
- `422` — Default Response
- `429` — Default Response
- `500` — Default Response
- `503` — Default Response

---

[API](https://skmtc.net/fiber/apis/fiber-ai-api.md) · [All operations](https://skmtc.net/fiber/apis/fiber-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fiber/fiber-ai-api/versions/0c537984b99f/schema)