Device Registration

Before generating APIs, you need to register your current device with a valid token to authenticate and enable API generation.

Registration Command

Global command:

apisorcery register -t <your-token> -r <your-remarks>

Local command:

npx @apisorcery/cli register -t <your-token> -r <your-remarks>

Parameter reference:

• <your-token>: A one-time temp token (valid for 15 minutes). Sign in to the console, open the Account Center page, and click Generate on the Temporary Token card. When multiple people share one account (Pro allows 5 devices, Team allows 15), each member registers with a token the admin generates and shares — no sub-accounts required; all registered devices share the account's quota.
• <your-remarks>: A user-defined device name — we recommend using your username (e.g. alice) so the admin can easily tell members apart in the console. Must be unique within the same account.

Example

apisorcery register -t 8f3a9c2d1e4b5f6a7c8d9e0f1a2b3c4d -r alice

After registration

All registered devices can be managed in the console under Personal Information → My Devices (rename, disable, remove, etc.). When multiple people share one account, the admin uses this page to view and maintain everyone's devices.

Important

• The remarks parameter is required
• Each device must have a unique remarks value under the same user account
• The remarks help you identify and manage different devices in the console
• One device can only be bound to one user and cannot be registered repeatedly

What happens during registration?

When you run the registration command:

1. Your device gets authenticated with the ApiSorcery service
2. The token is validated and associated with your device
3. Your device is authorized to generate APIs from configured services
4. The device registration is recorded on the server for authentication

Next Steps

After successful device registration, you're ready to start generating APIs! You can:

• Run apisorcery generate to generate API clients from your configured services
• Learn more about configuration to customize your setup
• Explore examples to see ApiSorcery in action

Troubleshooting

If you encounter issues during registration:

• Ensure your token is valid and not expired
• Check your internet connection

For additional help, please refer to our support documentation or contact support.