ByteRaven
  • 👋Welcome
  • Start a Project
  • Explore All Modules
  • User
    • 💡Introduction
    • Create a User
    • Get JWT for a User
    • Get a User
    • Update User Data
    • Deleting a User
  • SKILLS
    • 💡Introduction
    • Get Skills
    • Creating Skills
    • Update Skills
    • Delete Skills
  • Job Roles
    • 💡Introduction
    • Get Job Roles
    • Create Job Roles
    • Update Job Roles
    • Delete Job Roles
  • Candidate Profile
    • 💡Introduction
    • Get Candidate Profile
    • Create Candidate Profile
    • Generate Candidate Profile from Resume Transcript
  • Resume
    • 💡Introduction
    • Get Resume PDF Transcript
    • Create Resume Iteration (Analysis)
    • Get Resume Iteration/s
    • Get Resume Insights
    • Stream Resume Chat (SSE)
    • Save a Resume Chat Message
    • Get Resume Chat Messages
    • Create a Resume Template
    • Get Resume Templates
    • Build a Resume PDF
    • Get All Resume PDF Builds
  • Flash Cards
    • 💡Introduction
    • Create a Flash Card
    • Get Flash Cards
    • Update a Flash Card
    • Delete a Flash Card
    • Create Flash Card Status for a User
    • Get Flash Card Status for a User
    • Updating Flash Card Status for a User
    • Deleting Flash Cards Status for a User for that skill keyword
    • Bookmark / Unbookmark a Flash Card
    • Get Bookmarked Flash Cards for a User
  • Interview
    • 💡Introduction
    • Get Interview Templates
    • Create an Interview Template
    • Update Interview Template
    • Delete Interview Template
    • Create an Interview
    • Get Interview Data
    • Create Interview Message
    • Interview Question/Answer File Type Conversion
    • Update Interview Message
    • Get Interview Messages Data
    • Create Interview Report
    • Get Interview Report
  • Help & Support
    • Contact Us
Powered by GitBook
On this page

Start a Project

To start a project, you need to create an organisation in our platform

Getting Started with ByteRaven: Creating Your Organization

To begin using ByteRaven's backend services, you’ll first need to create an organization. This process establishes a new project within the platform and grants you the necessary credentials to start integrating our APIs into your solutions. Here’s how it works:

  1. Create a New Organization:

  • Initiating a new project on ByteRaven involves creating an organization. This step sets up your workspace where you can manage your resources, APIs, and data.

  1. Receive Your Unique Identifiers:

  • Unique Organization ID (orgId): Each organization is assigned a unique orgId. This identifier is critical for managing and differentiating your organization within ByteRaven’s ecosystem.

  • Unique Organization Alias (orgAlias): Along with the orgId, your organization will also receive a unique orgAlias. This alias is used to simplify references to your organization in API calls and within the ByteRaven platform.

  • Unique API Key (orgApiKey): Security is paramount, so each organization is provided with a unique orgApiKey. This key is required to authenticate and authorize API requests made to ByteRaven’s backend services.

  1. Contact Us for Organization Details and Plan Selection:

  • To obtain your organization specifics, including the orgId, orgAlias, and orgApiKey, you’ll need to contact our support team (Email us - akshit@byteraven.ai). During this process, you can also choose a plan that best suits your organization's needs, whether it’s for a small project or a large-scale deployment.

  1. Start Integrating and Building:

  • Once you have your organization set up with the unique identifiers and API key, you can begin integrating ByteRaven’s APIs into your frontend modules. Our platform is designed to be easy to use, so you can quickly start leveraging powerful backend capabilities to enhance your applications.

By following these steps, you’ll be well on your way to harnessing the full potential of ByteRaven’s backend platform, enabling you to build and deploy sophisticated features with ease.

Contact Us

PreviousWelcomeNextExplore All Modules

Last updated 8 months ago